+2009-06-13 Claudio Saavedra <csaavedra@igalia.com>
+
+ * hildon/hildon-animation-actor.c:
+ * hildon/hildon-app-menu.c:
+ * hildon/hildon-button.c:
+ * hildon/hildon-date-editor.c:
+ * hildon/hildon-dialog.c:
+ * hildon/hildon-edit-toolbar.c:
+ * hildon/hildon-entry.c:
+ * hildon/hildon-program.c:
+ * hildon/hildon-remote-texture.c:
+ * hildon/hildon-stackable-window.c:
+ * hildon/hildon-text-view.c:
+ * hildon/hildon-touch-selector.c:
+ * hildon/hildon-window-stack.c:
+ * hildon/hildon-window.c:
+
+ Remove redundant "represents" wording from most of the documentation.
+
+ Fixes: MB#4554 (Documentation: Annoying "represents" phrasing.)
+
2009-06-12 Alberto Garcia <agarcia@igalia.com>
* po/POTFILES.in
/**
* SECTION:hildon-animation-window
- * @short_description: Widget representing an animation actor for
+ * @short_description: Animation actor for
* WM-assisted animation effects in the Hildon framework.
*
- * The #HildonAnimationActor is a GTK+ widget which represents an
+ * The #HildonAnimationActor is an
* animation actor for WM-assisted animation effects in the Hildon
* framework. It derives from #GtkWindow and can host any widgets much
* like a normal window. The special features available to the
/**
* SECTION:hildon-app-menu
- * @short_description: Widget representing the application menu in the Hildon framework.
+ * @short_description: Application menu for Hildon applications.
*
- * #HildonAppMenu is a GTK widget which represents an application menu
- * in the Hildon framework.
+ * #HildonAppMenu is an application menu for applications in the Hildon
+ * framework.
*
* This menu opens from the top of the screen and contains a number of
* entries (#GtkButton) organized in one or two columns, depending on
/**
* SECTION:hildon-button
- * @short_description: Widget representing a button in the Hildon framework.
+ * @short_description: Two-label buttons in the Hildon framework.
*
- * The #HildonButton is a GTK widget which represents a clickable
- * button. It is derived from the #GtkButton widget and provides
+ * The #HildonButton is a clickable button for Hildon applications.
+ * It is derived from the #GtkButton widget and provides
* additional commodities specific to the Hildon framework.
*
* The height of a #HildonButton can be set to either "finger" height
/**
* hildon_date_editor_get_date:
* @date: the @HildonDateEditor widget
- * @year: year
- * @month: month
- * @day: day
+ * @year: a pointer to store the selected year
+ * @month: a pointer to store the selected month
+ * @day: a pointer to store the selected day
*
- * Gets the date represented by the date editor.
- * You can pass NULL to any of the pointers if
- * you're not interested in obtaining it.
+ * Gets the date selected in @date.
+ * You can pass %NULL in any of the pointers if
+ * you're not interested in obtaining a particular field.
*
*/
void
/**
* SECTION:hildon-dialog
- * @short_description: Widget representing a popup window in the Hildon framework.
+ * @short_description: A popup window in the Hildon framework.
* @see_also: #HildonCodeDialog, #HildonColorChooserDialog, #HildonFontSelectionDialog, #HildonGetPasswordDialog, #HildonLoginDialog, #HildonSetPasswordDialog, #HildonSortDialog, #HildonWizardDialog
*
- * #HildonDialog is a GTK widget which represent a popup window in the
+ * #HildonDialog is a popup window in the
* Hildon framework. It is derived from #GtkDialog and provides additional
* commodities specific to the Hildon framework.
*
/**
* SECTION:hildon-edit-toolbar
- * @short_description: Widget representing a toolbar for editing.
+ * @short_description: Toolbar for edition of user data.
*
* The #HildonEditToolbar is a toolbar which contains a label and two
* buttons, one of them being an arrow pointing backwards.
/**
* SECTION:hildon-entry
- * @short_description: Widget representing a text entry in the Hildon framework.
+ * @short_description: Text entry in the Hildon framework.
*
- * The #HildonEntry is a GTK widget which represents a text entry. It
- * is derived from the #GtkEntry widget and provides additional
- * commodities specific to the Hildon framework.
+ * The #HildonEntry is text entry derived from the #GtkEntry widget providing
+ * additional commodities specific to the Hildon framework.
*
* Besides all the features inherited from #GtkEntry, a #HildonEntry
* can also have a placeholder text. This text will be shown if the
/**
* SECTION:hildon-program
- * @short_description: An object that represents an application running in the Hildon framework.
+ * @short_description: Application abstraction in the Hildon framework.
* @see_also: #HildonWindow, #HildonStackableWindow
*
* #HildonProgram is an object used to represent an application running
/**
* SECTION:hildon-remote-texture
- * @short_description: Widget representing a Clutter/GLES texture created
+ * @short_description: Clutter/GLES texture created
* from a shared memory area.
*
* The #HildonRemoteTexture is a GTK+ widget which allows the rendering of
/**
* SECTION:hildon-stackable-window
- * @short_description: Widget representing a stackable, top-level window in the Hildon framework.
+ * @short_description: Stackable top-level window in the Hildon framework.
* @see_also: #HildonWindowStack, #HildonProgram, #HildonWindow
*
- * The #HildonStackableWindow is a GTK+ widget which represents a
- * top-level window in the Hildon framework. It is derived from
- * #HildonWindow. Applications that use stackable windows are organized
+ * The #HildonStackableWindow is a
+ * top-level window that can be stacked in a #HildonWindowStack. It is derived
+ * from #HildonWindow. Applications that use stackable windows are organized
* in a hierarchical way so users can go from any window back to the
* application's root window.
*
/**
* SECTION:hildon-text-view
- * @short_description: Widget representing a text view in the Hildon framework.
+ * @short_description: Text view within the Hildon framework.
*
- * The #HildonTextView is a GTK widget which represents a text
- * view. It is derived from the #GtkTextView widget and provides
+ * The #HildonTextView is a text
+ * view derived from the #GtkTextView widget that provides
* additional commodities specific to the Hildon framework.
*
* Besides all the features inherited from #GtkTextView, a
* #HildonPickerDialog activated from a button. For the most common
* cases, you should use #HildonPickerButton.
*
- * The composition of each column in the selector is represented by a
+ * The contents of each #HildonTouchSelector column are stored in a
* #GtkTreeModel. To add a new column to a #HildonTouchSelector, use
* hildon_touch_selector_append_column(). If you want to add a
* text-only column, without special attributes, use
* SECTION:hildon-touch-selector-column
* @short_description: A visible column in a #HildonTouchSelector
*
- * #HildonTouchSelectorColumn object represents a visible column in
- * #HildonTouchSelector. It allows to manage the cell renderers related to each
- * column.
+ * A #HildonTouchSelectorColumn is a column in a
+ * #HildonTouchSelector. This class implements the #GtkCellLayout interface, allowing
+ * a flexible management of the cellrenderers in each #HildonTouchSelector column.
*/
#undef HILDON_DISABLE_DEPRECATED
* @selector: a #HildonTouchSelector
* @func: a #HildonTouchSelectorPrintFunc function
*
- * Sets the function to be used by hildon_touch_selector_get_current_text()
- * to produce a text representation of the currently selected items in @selector.
- * The default function will return a concatenation of comma separated items
- * selected in each column in @selector. Use this to override this method if you
- * need a particular representation for your application.
+ * Sets the function to be used by hildon_touch_selector_get_current_text().
+ * See hildon_touch_selector_set_print_func_full().
*
* Since: 2.2
**/
/**
* SECTION:hildon-window-stack
- * @short_description: Object representing a stack of windows in the Hildon framework
+ * @short_description: A stack of windows in Hildon applications.
* @see_also: #HildonStackableWindow
*
- * The #HildonWindowStack is an object used to represent a stack of
- * windows in the Hildon framework.
+ * The #HildonWindowStack is a stack of top-level windows.
*
* Stacks contain all #HildonStackableWindow<!-- -->s that are being
* shown. The user can only interact with the topmost window from each
/**
* SECTION:hildon-window
- * @short_description: Widget representing a top-level window in the Hildon framework.
+ * @short_description: Top-level window in the Hildon framework.
* @see_also: #HildonProgram, #HildonStackableWindow
*
- * #HildonWindow is a GTK widget which represents a top-level
+ * #HildonWindow is a top-level
* window in the Hildon framework. It is derived from #GtkWindow
* and provides additional commodities specific to the Hildon
* framework.
projects / hildon / commitdiff