aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlberto Garcia <agarcia@igalia.com>2009-06-11 16:36:58 +0200
committerAlberto Garcia <agarcia@igalia.com>2009-06-11 16:36:58 +0200
commit2f02b97982246c9cfc408803f5a6b85459db6061 (patch)
treeb9911750b9be94d0fda4f3e1296d52310f6e31ef
parent01c54a1b0b89b139ae8bf62edaf952b54ad5bdf8 (diff)
Misc documentation updates
* hildon/hildon-code-dialog.c * hildon/hildon-date-editor.c * hildon/hildon-number-editor.c * hildon/hildon-seekbar.c * hildon/hildon-stackable-window.c * hildon/hildon-window.c: Misc documentation updates
-rw-r--r--ChangeLog10
-rw-r--r--hildon/hildon-code-dialog.c2
-rw-r--r--hildon/hildon-date-editor.c4
-rw-r--r--hildon/hildon-number-editor.c8
-rw-r--r--hildon/hildon-seekbar.c8
-rw-r--r--hildon/hildon-stackable-window.c2
-rw-r--r--hildon/hildon-window.c4
7 files changed, 29 insertions, 9 deletions
diff --git a/ChangeLog b/ChangeLog
index 3c51be8..aa303c2 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2009-06-11 Alberto Garcia <agarcia@igalia.com>
+
+ * hildon/hildon-code-dialog.c
+ * hildon/hildon-date-editor.c
+ * hildon/hildon-number-editor.c
+ * hildon/hildon-seekbar.c
+ * hildon/hildon-stackable-window.c
+ * hildon/hildon-window.c:
+ Misc documentation updates
+
2009-06-10 Claudio Saavedra <csaavedra@igalia.com>
* hildon/hildon-entry.c (hildon_entry_class_init): Make HildonEntry:size
diff --git a/hildon/hildon-code-dialog.c b/hildon/hildon-code-dialog.c
index 0c8d8ae..80e78d3 100644
--- a/hildon/hildon-code-dialog.c
+++ b/hildon/hildon-code-dialog.c
@@ -606,7 +606,7 @@ hildon_code_dialog_get_code (HildonCodeDialog *dialog)
}
/**
- * hildon_code_dialog_clear_clode:
+ * hildon_code_dialog_clear_code:
* @dialog: The #HildonCodeDialog whose entry should be cleared:
*
* Use this function to clear the user entered code.
diff --git a/hildon/hildon-date-editor.c b/hildon/hildon-date-editor.c
index eb8dee4..99726d3 100644
--- a/hildon/hildon-date-editor.c
+++ b/hildon/hildon-date-editor.c
@@ -1512,7 +1512,9 @@ hildon_date_editor_set_day (HildonDateEditor *editor,
/**
* hildon_date_editor_get_year:
- * @editor: the @HildonDateEditor widget
+ * @editor: the #HildonDateEditor widget
+ *
+ * Gets the year shown in the editor.
*
* Returns: the current year shown in the editor.
*/
diff --git a/hildon/hildon-number-editor.c b/hildon/hildon-number-editor.c
index 994918e..9f1be61 100644
--- a/hildon/hildon-number-editor.c
+++ b/hildon/hildon-number-editor.c
@@ -945,9 +945,11 @@ hildon_number_editor_set_range (HildonNumberEditor *editor,
/**
* hildon_number_editor_get_value:
- * @editor: pointer to #HildonNumberEditor
+ * @editor: a #HildonNumberEditor
*
- * Returns: current NumberEditor value
+ * Gets the current value of the number editor.
+ *
+ * Returns: the current value
*/
gint
hildon_number_editor_get_value (HildonNumberEditor *editor)
@@ -964,7 +966,7 @@ hildon_number_editor_get_value (HildonNumberEditor *editor)
/**
* hildon_number_editor_set_value:
- * @editor: pointer to #HildonNumberEditor
+ * @editor: a #HildonNumberEditor
* @value: numeric value for number editor
*
* Sets numeric value for number editor
diff --git a/hildon/hildon-seekbar.c b/hildon/hildon-seekbar.c
index de195fb..cc77140 100644
--- a/hildon/hildon-seekbar.c
+++ b/hildon/hildon-seekbar.c
@@ -328,9 +328,11 @@ hildon_seekbar_new (void)
/**
* hildon_seekbar_get_total_time:
- * @seekbar: pointer to #HildonSeekbar widget
+ * @seekbar: a #HildonSeekbar
+ *
+ * Gets the total playing time of the media (in seconds).
*
- * Returns: total playing time of media in seconds.
+ * Returns: total playing time.
*/
gint
hildon_seekbar_get_total_time (HildonSeekbar *seekbar)
@@ -344,7 +346,7 @@ hildon_seekbar_get_total_time (HildonSeekbar *seekbar)
/**
* hildon_seekbar_set_total_time:
- * @seekbar: pointer to #HildonSeekbar widget
+ * @seekbar: a #HildonSeekbar
* @time: integer greater than zero
*
* Set total playing time of media in seconds.
diff --git a/hildon/hildon-stackable-window.c b/hildon/hildon-stackable-window.c
index d047a96..28943d7 100644
--- a/hildon/hildon-stackable-window.c
+++ b/hildon/hildon-stackable-window.c
@@ -145,6 +145,8 @@ hildon_stackable_window_get_stack (HildonStackableWindow *self)
* @self: a #HildonStackableWindow
* @menu: a #HildonAppMenu to be used for this window
*
+ * Sets the menu to be used for this window.
+ *
* Deprecated: Hildon 2.2: use hildon_window_set_app_menu()
**/
void
diff --git a/hildon/hildon-window.c b/hildon/hildon-window.c
index 531e8a2..d524946 100644
--- a/hildon/hildon-window.c
+++ b/hildon/hildon-window.c
@@ -1860,7 +1860,7 @@ hildon_window_set_edit_toolbar (HildonWindow *self,
* hildon_window_get_main_menu:
* @self: a #HildonWindow
*
- * Gets the #GtkMenu assigned to the #HildonAppview. Note that the
+ * Gets the #GtkMenu assigned to the #HildonWindow. Note that the
* window is still the owner of the menu.
*
* Note that if you're using a #HildonAppMenu rather than a #GtkMenu
@@ -1886,6 +1886,8 @@ hildon_window_get_main_menu (HildonWindow * self)
* hildon_window_get_menu:
* @self: a #HildonWindow
*
+ * Gets the #GtkMenu assigned to @self
+ *
* Return value: a #GtkMenu
*
* Deprecated: In Hildon 2.2 this function has been renamed to