[maemo-commits] [maemo-commits] r9261 - in projects/haf/branches/hildon-libs/hildon-1: . src
From: subversion at stage.maemo.org subversion at stage.maemo.orgDate: Tue Jan 23 15:18:54 EET 2007
- Previous message: [maemo-commits] r9260 - in projects/haf/branches/gtk+/maemo-gtk-2-10: . gtk
- Next message: [maemo-commits] r9262 - in projects/haf/branches/hildon-libs/hildon-1: . src
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
Author: mdk Date: 2007-01-23 15:18:53 +0200 (Tue, 23 Jan 2007) New Revision: 9261 Modified: projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2 projects/haf/branches/hildon-libs/hildon-1/src/hildon-banner.c projects/haf/branches/hildon-libs/hildon-1/src/hildon-caption.c projects/haf/branches/hildon-libs/hildon-1/src/hildon-caption.h projects/haf/branches/hildon-libs/hildon-1/src/hildon-code-dialog.c projects/haf/branches/hildon-libs/hildon-1/src/hildon-controlbar.c Log: Fixing documentation for HildonBanner. Fixing documentation for HildonCaption. Fixing documentation for HildonCodeDialog. Fixing docuemtnation for HildonControlbar. Modified: projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2 =================================================================== --- projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2 2007-01-23 13:15:54 UTC (rev 9260) +++ projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2 2007-01-23 13:18:53 UTC (rev 9261) @@ -1,5 +1,16 @@ 2007-01-23 Michael Dominic Kostrzewa <michael.kostrzewa at nokia.com> + * src/hildon-banner.c: Fixing documentation for HildonBanner. + + * src/hildon-caption.c: + * src/hildon-caption.h: Fixing documentation for HildonCaption. + + * src/hildon-code-dialog.c: Fixing documentation for HildonCodeDialog. + + * src/hildon-controlbar.c: Fixing docuemtnation for HildonControlbar. + +2007-01-23 Michael Dominic Kostrzewa <michael.kostrzewa at nokia.com> + * src/hildon-banner.c: * src/hildon-banner.h: Fixing documentation. Removing the n-lines helper function. Modified: projects/haf/branches/hildon-libs/hildon-1/src/hildon-banner.c =================================================================== --- projects/haf/branches/hildon-libs/hildon-1/src/hildon-banner.c 2007-01-23 13:15:54 UTC (rev 9260) +++ projects/haf/branches/hildon-libs/hildon-1/src/hildon-banner.c 2007-01-23 13:18:53 UTC (rev 9261) @@ -22,6 +22,18 @@ * */ +/** + * SECTION:hildon-banner + * @short_description: A widget used to display timed notifications. + * + * #HildonBanner can be used to display a short, timed notification + * or information to the user. It can communicate that a + * task has been finished or the application state has changed. + * Banners should be used only to display non-critical pieces of + * information. + * + */ + #ifdef HAVE_CONFIG_H #include <config.h> #endif Modified: projects/haf/branches/hildon-libs/hildon-1/src/hildon-caption.c =================================================================== --- projects/haf/branches/hildon-libs/hildon-1/src/hildon-caption.c 2007-01-23 13:15:54 UTC (rev 9260) +++ projects/haf/branches/hildon-libs/hildon-1/src/hildon-caption.c 2007-01-23 13:18:53 UTC (rev 9261) @@ -153,7 +153,7 @@ /** * hildon_caption_get_type: * - * Initialises, and returns the type of a hildon caption. + * Initializes and returns the type of a hildon caption. * * @Returns: GType of #HildonCaption */ @@ -1063,7 +1063,8 @@ * The default seaparator character is ":" * separately. */ -void hildon_caption_set_separator (HildonCaption *caption, +void +hildon_caption_set_separator (HildonCaption *caption, const gchar *separator) { g_return_if_fail (HILDON_IS_CAPTION (caption)); @@ -1110,7 +1111,7 @@ /** * hildon_caption_set_child_expand: * @caption : a #HildonCaption - * @expand : gboolean to determine is the child expandable + * @expand : gboolean to determine if the child is expandable * * Sets child expandability. */ Modified: projects/haf/branches/hildon-libs/hildon-1/src/hildon-caption.h =================================================================== --- projects/haf/branches/hildon-libs/hildon-1/src/hildon-caption.h 2007-01-23 13:15:54 UTC (rev 9260) +++ projects/haf/branches/hildon-libs/hildon-1/src/hildon-caption.h 2007-01-23 13:18:53 UTC (rev 9261) @@ -72,7 +72,6 @@ * * Keys to set the icon placement in #HildonCaption. * - * Since: 0.14.5 */ typedef enum { Modified: projects/haf/branches/hildon-libs/hildon-1/src/hildon-code-dialog.c =================================================================== --- projects/haf/branches/hildon-libs/hildon-1/src/hildon-code-dialog.c 2007-01-23 13:15:54 UTC (rev 9260) +++ projects/haf/branches/hildon-libs/hildon-1/src/hildon-code-dialog.c 2007-01-23 13:18:53 UTC (rev 9261) @@ -22,6 +22,17 @@ * */ +/** + * SECTION:hildon-code-dialog + * @short_description: A keypad-like widget used to enter pincodes. + * + * #HildonCodeDialog displays a keypad that can be used to enter + * numerical pin codes or lock codes. + * + */ + +/* FIXME We need property access in this widget */ + #ifdef HAVE_CONFIG_H #include <config.h> #endif @@ -88,6 +99,13 @@ static GtkDialogClass* parent_class = NULL; +/** + * hildon_code_dialog_get_type: + * + * Initializes and returns the type of a hildon code dialog. + * + * @Returns: GType of #HildonCodeDialog + */ GType G_GNUC_CONST hildon_code_dialog_get_type (void) { Modified: projects/haf/branches/hildon-libs/hildon-1/src/hildon-controlbar.c =================================================================== --- projects/haf/branches/hildon-libs/hildon-1/src/hildon-controlbar.c 2007-01-23 13:15:54 UTC (rev 9260) +++ projects/haf/branches/hildon-libs/hildon-1/src/hildon-controlbar.c 2007-01-23 13:18:53 UTC (rev 9261) @@ -139,6 +139,13 @@ gdouble new_value, gpointer data); +/** + * hildon_controlbar_get_type: + * + * Initializes and returns the type of a hildon control bar. + * + * @Returns: GType of #HildonControlbar + */ GType G_GNUC_CONST hildon_controlbar_get_type (void) { @@ -213,7 +220,7 @@ /** * HildonControlbar:value: * - * Controlbar value. + * Controlbar current value. */ g_object_class_install_property (gobject_class, PROP_VALUE, g_param_spec_int ("value", @@ -413,7 +420,7 @@ * @self: pointer to #HildonControlbar * @value: value in range of >= 0 && < G_MAX_INT * - * Change the current value of the control bar to the specified value. + * Set the current value of the control bar to the specified value. */ void hildon_controlbar_set_value (HildonControlbar * self, @@ -576,7 +583,7 @@ * Event handler for button press * Need to change button1 to button2 before passing this event to * parent handler. (see specs) - * Also updates button_press variable so that we can draw hilites + * Also updates button_press variable so that we can draw highlights * correctly */ static gint
- Previous message: [maemo-commits] r9260 - in projects/haf/branches/gtk+/maemo-gtk-2-10: . gtk
- Next message: [maemo-commits] r9262 - in projects/haf/branches/hildon-libs/hildon-1: . src
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]