[maemo-commits] [maemo-commits] r9312 - in projects/haf/branches/hildon-libs/hildon-1: . src

Wed Jan 24 17:41:36 EET 2007

Author: mdk
Date: 2007-01-24 17:41:35 +0200 (Wed, 24 Jan 2007)
New Revision: 9312

Modified:
   projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2
   projects/haf/branches/hildon-libs/hildon-1/src/hildon-program.c
   projects/haf/branches/hildon-libs/hildon-1/src/hildon-program.h
   projects/haf/branches/hildon-libs/hildon-1/src/hildon-range-editor.c
   projects/haf/branches/hildon-libs/hildon-1/src/hildon-seekbar.c
   projects/haf/branches/hildon-libs/hildon-1/src/hildon-set-password-dialog.c
Log:
Cleaning up the documentation.


Modified: projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2
===================================================================

--- projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2	2007-01-24 15:34:52 UTC (rev 9311)
+++ projects/haf/branches/hildon-libs/hildon-1/ChangeLog.2	2007-01-24 15:41:35 UTC (rev 9312)
@@ -1,5 +1,13 @@
 2007-01-24  Michael Dominic Kostrzewa  <michael.kostrzewa at nokia.com> 
 
+	* src/hildon-program.c:
+	* src/hildon-program.h:
+	* src/hildon-range-editor.c:
+	* src/hildon-seekbar.c:
+	* src/hildon-set-password-dialog.c: Cleaing up the documentation.
+
+2007-01-24  Michael Dominic Kostrzewa  <michael.kostrzewa at nokia.com> 
+
 	* src/hildon-get-password-dialog.c:
 	* src/hildon-helper.c:
 	* src/hildon-hvolumebar.c:

Modified: projects/haf/branches/hildon-libs/hildon-1/src/hildon-program.c
===================================================================
--- projects/haf/branches/hildon-libs/hildon-1/src/hildon-program.c	2007-01-24 15:34:52 UTC (rev 9311)
+++ projects/haf/branches/hildon-libs/hildon-1/src/hildon-program.c	2007-01-24 15:41:35 UTC (rev 9312)
@@ -22,11 +22,12 @@
  *
  */
 
-/*
- * @file hildon-program.c
+/**
+ * SECTION:hildon-program
+ * @short_description: An object used to control a hildon program.
  *
- * This file implements the HildonProgram object
- *
+ * HildonProgram is not a widget itself nor a container. HildonProgram can 
+ * contain one or more @HildonWindow. 
  */
 
 #ifdef                                          HAVE_CONFIG_H
@@ -65,7 +66,7 @@
     PROP_KILLABLE
 };
 
-GType
+GType G_GNUC_CONST
 hildon_program_get_type                         (void)
 {
     static GType program_type = 0;
@@ -138,6 +139,13 @@
     object_class->get_property  = hildon_program_get_property;
 
     /* Install properties */
+
+    /**
+     * HildonProgram:is-topmost:
+     *
+     * Whether one of the program's window or dialog currently
+     * is activated by window manager. 
+     */
     g_object_class_install_property (object_class, PROP_IS_TOPMOST,
                 g_param_spec_boolean ("is-topmost",
                 "Is top-most",
@@ -145,7 +153,13 @@
                 "is activated by window manager",
                 FALSE,
                 G_PARAM_READABLE)); 
-    
+
+    /**
+     * HildonProgram:can-hibernate:
+     *
+     * Whether the program should be set to hibernate by the Task
+     * Navigator in low memory situation.
+     */
     g_object_class_install_property (object_class, PROP_KILLABLE,
                 g_param_spec_boolean ("can-hibernate",
                 "Can hibernate",

Modified: projects/haf/branches/hildon-libs/hildon-1/src/hildon-program.h
===================================================================
--- projects/haf/branches/hildon-libs/hildon-1/src/hildon-program.h	2007-01-24 15:34:52 UTC (rev 9311)
+++ projects/haf/branches/hildon-libs/hildon-1/src/hildon-program.h	2007-01-24 15:41:35 UTC (rev 9312)
@@ -70,7 +70,7 @@
     void (*_hildon_reserved4)(void);
 };
 
-GType
+GType G_GNUC_CONST
 hildon_program_get_type                         (void);
 
 HildonProgram*

Modified: projects/haf/branches/hildon-libs/hildon-1/src/hildon-range-editor.c
===================================================================
--- projects/haf/branches/hildon-libs/hildon-1/src/hildon-range-editor.c	2007-01-24 15:34:52 UTC (rev 9311)
+++ projects/haf/branches/hildon-libs/hildon-1/src/hildon-range-editor.c	2007-01-24 15:41:35 UTC (rev 9312)
@@ -789,8 +789,6 @@
     gtk_entry_set_max_length (GTK_ENTRY (priv->end_entry), length);
 }
 
-/* Public functions */
-
 /**
  * hildon_range_editor_get_type:
  * 
@@ -799,7 +797,7 @@
  * @Returns : GType of #HildonRangeEditor
  * 
  */
-GType
+GType G_GNUC_CONST
 hildon_range_editor_get_type                    (void)
 {
     static GType editor_type = 0;

Modified: projects/haf/branches/hildon-libs/hildon-1/src/hildon-seekbar.c
===================================================================
--- projects/haf/branches/hildon-libs/hildon-1/src/hildon-seekbar.c	2007-01-24 15:34:52 UTC (rev 9311)
+++ projects/haf/branches/hildon-libs/hildon-1/src/hildon-seekbar.c	2007-01-24 15:41:35 UTC (rev 9312)
@@ -131,7 +131,12 @@
 };
 
 /**
- * Initialises, and returns the type of a hildon seekbar.
+ * hildon_seekbar_get_type:
+ * 
+ * Initializes, and returns the type of a hildon seekbar.
+ * 
+ * @Returns : GType of #HildonSeekbar
+ * 
  */
 GType G_GNUC_CONST 
 hildon_seekbar_get_type                         (void)
@@ -181,8 +186,13 @@
     object_class->set_property          = hildon_seekbar_set_property;
     object_class->get_property          = hildon_seekbar_get_property;
 
+    /**
+     * HildonSeekbar:total-time:
+     *
+     * Total playing time of this media file.
+     */
     g_object_class_install_property (object_class, PROP_TOTAL_TIME,
-            g_param_spec_double ("total_time",
+            g_param_spec_double ("total-time",
                 "total time",
                 "Total playing time of this media file",
                 0,           /* min value */
@@ -190,6 +200,11 @@
                 0,           /* default */
                 G_PARAM_READWRITE));
 
+    /**
+     * HildonSeekbar:position:
+     *
+     * Current position in this media file.
+     */
     g_object_class_install_property (object_class, PROP_POSITION,
             g_param_spec_double ("position",
                 "position",
@@ -199,6 +214,11 @@
                 0,           /* default */
                 G_PARAM_READWRITE));
 
+    /**
+     * HildonSeekbar:fraction:
+     *
+     * Current fraction related to the progress indicator.
+     */
     g_object_class_install_property (object_class, PROP_FRACTION,
             g_param_spec_double ("fraction",
                 "Fraction",

Modified: projects/haf/branches/hildon-libs/hildon-1/src/hildon-set-password-dialog.c
===================================================================
--- projects/haf/branches/hildon-libs/hildon-1/src/hildon-set-password-dialog.c	2007-01-24 15:34:52 UTC (rev 9311)
+++ projects/haf/branches/hildon-libs/hildon-1/src/hildon-set-password-dialog.c	2007-01-24 15:41:35 UTC (rev 9312)
@@ -345,15 +345,25 @@
                 NULL,
                 G_PARAM_READWRITE));
 
+    /**
+     * HildonSetPasswordDialog:modify-protection:
+     *
+     * Password type.
+     */
     g_object_class_install_property (object_class, 
             PROP_HILDON_PASSWORD_DIALOG, 
-            g_param_spec_boolean ("modify_protection",
+            g_param_spec_boolean ("modify-protection",
                 "Password type",
                 "Set type to dialog",
                 TRUE, 
                 G_PARAM_CONSTRUCT_ONLY |
                 G_PARAM_READWRITE));
 
+    /**
+     * HildonSetPasswordDialog:password:
+     *
+     * Content of the password field.
+     */
     g_object_class_install_property (object_class, 
             PROP_PASSWORD, 
             g_param_spec_string ("password",


