From 30145d2600fdb0a434350f631064cbfbbf9f03eb Mon Sep 17 00:00:00 2001 From: Claudio Saavedra Date: Sat, 13 Jun 2009 13:47:34 +0300 Subject: [PATCH] Remove redundant "represents" wording from most of the documentation. Fixes: MB#4554 (Documentation: Annoying "represents" phrasing.) --- ChangeLog | 21 +++++++++++++++++++++ hildon/hildon-animation-actor.c | 4 ++-- hildon/hildon-app-menu.c | 6 +++--- hildon/hildon-button.c | 6 +++--- hildon/hildon-date-editor.c | 12 ++++++------ hildon/hildon-dialog.c | 4 ++-- hildon/hildon-edit-toolbar.c | 2 +- hildon/hildon-entry.c | 7 +++---- hildon/hildon-program.c | 2 +- hildon/hildon-remote-texture.c | 2 +- hildon/hildon-stackable-window.c | 8 ++++---- hildon/hildon-text-view.c | 6 +++--- hildon/hildon-touch-selector.c | 15 ++++++--------- hildon/hildon-window-stack.c | 5 ++--- hildon/hildon-window.c | 4 ++-- 15 files changed, 60 insertions(+), 44 deletions(-) diff --git a/ChangeLog b/ChangeLog index 1073786..aeb2f0f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,24 @@ +2009-06-13 Claudio Saavedra + + * 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 * po/POTFILES.in diff --git a/hildon/hildon-animation-actor.c b/hildon/hildon-animation-actor.c index b826ffb..834c437 100644 --- a/hildon/hildon-animation-actor.c +++ b/hildon/hildon-animation-actor.c @@ -24,10 +24,10 @@ /** * 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 diff --git a/hildon/hildon-app-menu.c b/hildon/hildon-app-menu.c index a7e2d0b..e71fdaf 100644 --- a/hildon/hildon-app-menu.c +++ b/hildon/hildon-app-menu.c @@ -18,10 +18,10 @@ /** * 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 diff --git a/hildon/hildon-button.c b/hildon/hildon-button.c index 6a0b71f..dd28e27 100644 --- a/hildon/hildon-button.c +++ b/hildon/hildon-button.c @@ -18,10 +18,10 @@ /** * 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 diff --git a/hildon/hildon-date-editor.c b/hildon/hildon-date-editor.c index 99726d3..f64da51 100644 --- a/hildon/hildon-date-editor.c +++ b/hildon/hildon-date-editor.c @@ -799,13 +799,13 @@ hildon_date_editor_set_date (HildonDateEditor *editor, /** * 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 diff --git a/hildon/hildon-dialog.c b/hildon/hildon-dialog.c index 5b5653e..1a3977c 100644 --- a/hildon/hildon-dialog.c +++ b/hildon/hildon-dialog.c @@ -24,10 +24,10 @@ /** * 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. * diff --git a/hildon/hildon-edit-toolbar.c b/hildon/hildon-edit-toolbar.c index 2dd12fb..c288c71 100644 --- a/hildon/hildon-edit-toolbar.c +++ b/hildon/hildon-edit-toolbar.c @@ -16,7 +16,7 @@ /** * 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. diff --git a/hildon/hildon-entry.c b/hildon/hildon-entry.c index 58066c2..eb8d22a 100644 --- a/hildon/hildon-entry.c +++ b/hildon/hildon-entry.c @@ -16,11 +16,10 @@ /** * 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 diff --git a/hildon/hildon-program.c b/hildon/hildon-program.c index 47ead29..49aafde 100644 --- a/hildon/hildon-program.c +++ b/hildon/hildon-program.c @@ -24,7 +24,7 @@ /** * 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 diff --git a/hildon/hildon-remote-texture.c b/hildon/hildon-remote-texture.c index 8440158..b39202d 100644 --- a/hildon/hildon-remote-texture.c +++ b/hildon/hildon-remote-texture.c @@ -24,7 +24,7 @@ /** * 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 diff --git a/hildon/hildon-stackable-window.c b/hildon/hildon-stackable-window.c index 28943d7..317f35a 100644 --- a/hildon/hildon-stackable-window.c +++ b/hildon/hildon-stackable-window.c @@ -24,12 +24,12 @@ /** * 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. * diff --git a/hildon/hildon-text-view.c b/hildon/hildon-text-view.c index 4630999..4fb0086 100644 --- a/hildon/hildon-text-view.c +++ b/hildon/hildon-text-view.c @@ -16,10 +16,10 @@ /** * 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 diff --git a/hildon/hildon-touch-selector.c b/hildon/hildon-touch-selector.c index d93ab73..a907a76 100644 --- a/hildon/hildon-touch-selector.c +++ b/hildon/hildon-touch-selector.c @@ -30,7 +30,7 @@ * #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 @@ -153,9 +153,9 @@ * 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 @@ -1486,11 +1486,8 @@ hildon_touch_selector_set_column_selection_mode (HildonTouchSelector * selector, * @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 **/ diff --git a/hildon/hildon-window-stack.c b/hildon/hildon-window-stack.c index 69d28a8..f720818 100644 --- a/hildon/hildon-window-stack.c +++ b/hildon/hildon-window-stack.c @@ -22,11 +22,10 @@ /** * 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 #HildonStackableWindows that are being * shown. The user can only interact with the topmost window from each diff --git a/hildon/hildon-window.c b/hildon/hildon-window.c index b68820a..2f02a38 100644 --- a/hildon/hildon-window.c +++ b/hildon/hildon-window.c @@ -24,10 +24,10 @@ /** * 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. -- 1.7.9.5