[libgda/LIBGDA_4.2] Doc. format corrections



commit 672f0cfdfaef9b5f8c055d980f695eb25a117348
Author: Vivien Malerba <malerba gnome-db org>
Date:   Mon Jun 13 17:02:13 2011 +0200

    Doc. format corrections

 .../data-entries/gdaui-data-cell-renderer-bin.c    |    2 +-
 .../gdaui-data-cell-renderer-boolean.c             |    2 +-
 .../data-entries/gdaui-data-cell-renderer-combo.c  |    2 +-
 .../gdaui-data-cell-renderer-textual.c             |    2 +-
 .../plugins/gdaui-data-cell-renderer-password.c    |    2 +-
 .../plugins/gdaui-data-cell-renderer-pict.c        |    2 +-
 libgda-ui/demos/main.c                             |    2 +-
 libgda/gda-holder.c                                |    2 +-
 libgda/gda-init.c                                  |    8 ++++----
 libgda/gda-set.c                                   |    4 ++--
 10 files changed, 14 insertions(+), 14 deletions(-)
---
diff --git a/libgda-ui/data-entries/gdaui-data-cell-renderer-bin.c b/libgda-ui/data-entries/gdaui-data-cell-renderer-bin.c
index 77457ae..43615e2 100644
--- a/libgda-ui/data-entries/gdaui-data-cell-renderer-bin.c
+++ b/libgda-ui/data-entries/gdaui-data-cell-renderer-bin.c
@@ -328,7 +328,7 @@ gdaui_data_cell_renderer_bin_set_property (GObject *object,
  * in the model, thus causing the check button to reflect the state of
  * the model.
  * 
- * Return value: (transfer full): the new cell renderer
+ * Returns: (transfer full): the new cell renderer
  */
 GtkCellRenderer *
 gdaui_data_cell_renderer_bin_new (GdaDataHandler *dh, GType type)
diff --git a/libgda-ui/data-entries/gdaui-data-cell-renderer-boolean.c b/libgda-ui/data-entries/gdaui-data-cell-renderer-boolean.c
index b153e12..16ab901 100644
--- a/libgda-ui/data-entries/gdaui-data-cell-renderer-boolean.c
+++ b/libgda-ui/data-entries/gdaui-data-cell-renderer-boolean.c
@@ -335,7 +335,7 @@ gdaui_data_cell_renderer_boolean_set_property (GObject *object,
  * in the model, thus causing the check button to reflect the state of
  * the model.
  *
- * Return value: (transfer full): the new cell renderer
+ * Returns: (transfer full): the new cell renderer
  */
 GtkCellRenderer *
 gdaui_data_cell_renderer_boolean_new (GdaDataHandler *dh, GType type)
diff --git a/libgda-ui/data-entries/gdaui-data-cell-renderer-combo.c b/libgda-ui/data-entries/gdaui-data-cell-renderer-combo.c
index 1ed7ab4..ba4e5ec 100644
--- a/libgda-ui/data-entries/gdaui-data-cell-renderer-combo.c
+++ b/libgda-ui/data-entries/gdaui-data-cell-renderer-combo.c
@@ -437,7 +437,7 @@ render_text_to_display_from_values (GList *values)
  * Creates a new #GdauiDataCellRendererCombo which will fill the parameters listed in
  * @source->nodes with values available from @source->data_model.
  * 
- * Return value: (transfer full): the new cell renderer
+ * Returns: (transfer full): the new cell renderer
  **/
 GtkCellRenderer *
 gdaui_data_cell_renderer_combo_new (GdauiSet *paramlist, GdauiSetSource *source)
diff --git a/libgda-ui/data-entries/gdaui-data-cell-renderer-textual.c b/libgda-ui/data-entries/gdaui-data-cell-renderer-textual.c
index 89b5237..f55eebe 100644
--- a/libgda-ui/data-entries/gdaui-data-cell-renderer-textual.c
+++ b/libgda-ui/data-entries/gdaui-data-cell-renderer-textual.c
@@ -584,7 +584,7 @@ gdaui_data_cell_renderer_textual_set_property (GObject *object,
  * value in the model, thus rendering a different string in each row
  * of the #GtkTreeView
  *
- * Return value: (transfer full): the new cell renderer
+ * Returns: (transfer full): the new cell renderer
  **/
 GtkCellRenderer *
 gdaui_data_cell_renderer_textual_new (GdaDataHandler *dh, GType type, const gchar *options)
diff --git a/libgda-ui/data-entries/plugins/gdaui-data-cell-renderer-password.c b/libgda-ui/data-entries/plugins/gdaui-data-cell-renderer-password.c
index de11862..f198119 100644
--- a/libgda-ui/data-entries/plugins/gdaui-data-cell-renderer-password.c
+++ b/libgda-ui/data-entries/plugins/gdaui-data-cell-renderer-password.c
@@ -342,7 +342,7 @@ gdaui_data_cell_renderer_password_set_property (GObject *object,
  *
  * Creates a new #GdauiDataCellRendererPassword.
  *
- * Return value: the new cell renderer
+ * Returns: the new cell renderer
  **/
 GtkCellRenderer *
 gdaui_data_cell_renderer_password_new (GdaDataHandler *dh, GType type, const gchar *options)
diff --git a/libgda-ui/data-entries/plugins/gdaui-data-cell-renderer-pict.c b/libgda-ui/data-entries/plugins/gdaui-data-cell-renderer-pict.c
index 01ab17b..8988b6f 100644
--- a/libgda-ui/data-entries/plugins/gdaui-data-cell-renderer-pict.c
+++ b/libgda-ui/data-entries/plugins/gdaui-data-cell-renderer-pict.c
@@ -355,7 +355,7 @@ gdaui_data_cell_renderer_pict_set_property (GObject *object,
  * in the model, thus causing the check button to reflect the state of
  * the model.
  *
- * Return value: the new cell renderer
+ * Returns: the new cell renderer
  */
 GtkCellRenderer *
 gdaui_data_cell_renderer_pict_new (GdaDataHandler *dh, GType type, const gchar *options)
diff --git a/libgda-ui/demos/main.c b/libgda-ui/demos/main.c
index 3f2aab9..39f7dbb 100644
--- a/libgda-ui/demos/main.c
+++ b/libgda-ui/demos/main.c
@@ -48,7 +48,7 @@ struct _CallbackData
  * location GTK+ where it will be installed on make install,
  * returns the first file found.
  * 
- * Return value: the filename, if found or %NULL
+ * Returns: the filename, if found or %NULL
  **/
 gchar *
 demo_find_file (const char *base, GError **err)
diff --git a/libgda/gda-holder.c b/libgda/gda-holder.c
index 339aad0..e15ce21 100644
--- a/libgda/gda-holder.c
+++ b/libgda/gda-holder.c
@@ -236,7 +236,7 @@ gda_holder_class_init (GdaHolderClass *class)
 	 * Gets emitted when @holder is going to change its value. One can connect to
 	 * this signal to control which values @holder can have (for example to implement some business rules)
 	 *
-	 * Return value: NULL if @holder is allowed to change its value to @new_value, or a #GError
+	 * Returns: NULL if @holder is allowed to change its value to @new_value, or a #GError
 	 * otherwise.
 	 */
 	gda_holder_signals[VALIDATE_CHANGE] =
diff --git a/libgda/gda-init.c b/libgda/gda-init.c
index c370a75..d8354d7 100644
--- a/libgda/gda-init.c
+++ b/libgda/gda-init.c
@@ -65,7 +65,7 @@ static gboolean lang_locale_dyn = FALSE;
 gchar          *gda_lang_locale = "";
 
 /**
- * gda_locale_changed
+ * gda_locale_changed:
  *
  * Call this function whenever the setlocale() function has been called
  * to change the current locale; this function is first called by gda_init() so you
@@ -111,7 +111,7 @@ gda_locale_changed (void)
 }
 
 /**
- * gda_init
+ * gda_init:
  * 
  * Initializes the GDA library, must be called prior to any Libgda usage. Note that unless the
  * LIBGDA_NO_THREADS environment variable is set (to any value), the GLib thread system will
@@ -260,7 +260,7 @@ gda_init (void)
 }
 
 /**
- * gda_get_application_exec_path
+ * gda_get_application_exec_path:
  * @app_name: the name of the application to find
  *
  * Find the path to the application identified by @app_name. For example if the application
@@ -268,7 +268,7 @@ gda_init (void)
  * "/your/prefix/bin/gda-sql-4.0" if Libgda is installed in
  * the "/your/prefix" prefix (which would usually be "/usr"), and for the ABI version 4.0.
  *
- * Returns: the path as a new string, or %NULL if the application cannot be found
+ * Returns: (transfer full): the path as a new string, or %NULL if the application cannot be found
  */
 gchar *
 gda_get_application_exec_path (const gchar *app_name)
diff --git a/libgda/gda-set.c b/libgda/gda-set.c
index f0df2f3..d39a1c8 100644
--- a/libgda/gda-set.c
+++ b/libgda/gda-set.c
@@ -260,7 +260,7 @@ gda_set_class_init (GdaSetClass *class)
 	 * Gets emitted when a #GdaHolder's in @set is going to change its value. One can connect to
 	 * this signal to control which values @holder can have (for example to implement some business rules)
 	 *
-	 * Return value: NULL if @holder is allowed to change its value to @new_value, or a #GError
+	 * Returns: NULL if @holder is allowed to change its value to @new_value, or a #GError
 	 * otherwise.
 	 */
 	gda_set_signals[VALIDATE_HOLDER_CHANGE] =
@@ -278,7 +278,7 @@ gda_set_class_init (GdaSetClass *class)
 	 * Gets emitted when gda_set_is_valid() is called, use
 	 * this signal to control which combination of values @set's holder can have (for example to implement some business rules)
 	 *
-	 * Return value: NULL if @set's contents has been validated, or a #GError
+	 * Returns: NULL if @set's contents has been validated, or a #GError
 	 * otherwise.
 	 */
 	gda_set_signals[VALIDATE_SET] =



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]