[libgda/gtk3] Documentation corrections

[Vivien Malerba <vivien src gnome org>]

commit 75352453fc91e89b692fbae9cce62d45853deea9
Author: Vivien Malerba <malerba gnome-db org>
Date:   Mon Feb 14 21:54:32 2011 +0100

    Documentation corrections

 doc/C/tmpl/gda-meta-struct.sgml  |   15 +++++----------
 doc/C/tmpl/gdaui-basic-form.sgml |    8 ++++++++
 libgda-ui/gdaui-basic-form.c     |   13 +++++++------
 libgda-ui/gdaui-raw-grid.c       |   15 +++++++++++++++
 libgda/gda-meta-struct.h         |   10 ++++++----
 5 files changed, 41 insertions(+), 20 deletions(-)
---
diff --git a/doc/C/tmpl/gda-meta-struct.sgml b/doc/C/tmpl/gda-meta-struct.sgml
index 0a0322b..7a66d08 100644
--- a/doc/C/tmpl/gda-meta-struct.sgml
+++ b/doc/C/tmpl/gda-meta-struct.sgml
@@ -129,21 +129,16 @@ gda_meta_struct_free (mstruct);
 
 <!-- ##### ENUM GdaMetaDbObjectType ##### -->
 <para>
-  Type of database object represented by a #GdaMetaDbObject structure
+
 </para>
 
- GDA_META_DB_UNKNOWN: unknown type, we only know the object exists
- GDA_META_DB_TABLE: the object is a table
- GDA_META_DB_VIEW: the object is a view
+ GDA_META_DB_UNKNOWN: 
+ GDA_META_DB_TABLE: 
+ GDA_META_DB_VIEW: 
 
 <!-- ##### STRUCT GdaMetaDbObject ##### -->
 <para>
-  Struture to hold information about each database object (tables, views, triggers, ...)
-</para>
-<para>
-  Note: @obj_catalog, @obj_schema, @obj_name, @obj_short_name and @obj_full_name are case sensitive:
-  one must call gda_sql_identifier_needs_quotes() to know if is it is necessary to surround by double quotes
-  before using in an SQL statement
+
 </para>
 
 @obj_type: 
diff --git a/doc/C/tmpl/gdaui-basic-form.sgml b/doc/C/tmpl/gdaui-basic-form.sgml
index 7948294..264cb96 100644
--- a/doc/C/tmpl/gdaui-basic-form.sgml
+++ b/doc/C/tmpl/gdaui-basic-form.sgml
@@ -136,6 +136,14 @@ which can be described by the following DTD.
 
 @gdauibasicform: the object which received the signal.
 
+<!-- ##### SIGNAL GdauiBasicForm::populate-popup ##### -->
+<para>
+
+</para>
+
+ gdauibasicform: the object which received the signal.
+ arg1: 
+
 <!-- ##### ARG GdauiBasicForm:can-expand-v ##### -->
 <para>
 
diff --git a/libgda-ui/gdaui-basic-form.c b/libgda-ui/gdaui-basic-form.c
index cbaf5e5..2c034c2 100644
--- a/libgda-ui/gdaui-basic-form.c
+++ b/libgda-ui/gdaui-basic-form.c
@@ -209,11 +209,11 @@ gdaui_basic_form_class_init (GdauiBasicFormClass * class)
 	/* signals */
 	/**
 	 * GdauiBasicForm::holder-changed:
-	 * @form: GdauiBasicForm
-	 * @param: that changed
+	 * @form: #GdauiBasicForm
+	 * @param: the #GdaHolder that changed
 	 * @is_user_modif: TRUE if the modification has been initiated by a user modification
 	 *
-	 * Emitted when a GdaHolder changes
+	 * Emitted when a GdaHolder changed in @form
 	 */
 	gdaui_basic_form_signals[HOLDER_CHANGED] =
 		g_signal_new ("holder-changed",
@@ -225,7 +225,7 @@ gdaui_basic_form_class_init (GdauiBasicFormClass * class)
 			      GDA_TYPE_HOLDER, G_TYPE_BOOLEAN);
 	/**
 	 * GdauiBasicForm::activated:
-	 * @form: GdauiBasicForm
+	 * @form: #GdauiBasicForm
 	 *
 	 * Emitted when the use has activated any of the #GdaDataEntry widget
 	 * in @form.
@@ -240,7 +240,7 @@ gdaui_basic_form_class_init (GdauiBasicFormClass * class)
 
 	/**
 	 * GdauiBasicForm::layout-changed:
-	 * @form: GdauiBasicForm
+	 * @form: #GdauiBasicForm
 	 *
 	 * Emitted when the form's layout changes
 	 */
@@ -254,7 +254,8 @@ gdaui_basic_form_class_init (GdauiBasicFormClass * class)
 
 	/**
 	 * GdauiBasicForm::populate-popup:
-	 * @form: GdauiBasicForm
+	 * @form: #GdauiBasicForm
+	 * @menu: a #GtkMenu to modify
 	 *
 	 * Connect this signal and modify the popup menu.
 	 *
diff --git a/libgda-ui/gdaui-raw-grid.c b/libgda-ui/gdaui-raw-grid.c
index 0e090b9..f7eb345 100644
--- a/libgda-ui/gdaui-raw-grid.c
+++ b/libgda-ui/gdaui-raw-grid.c
@@ -260,6 +260,13 @@ gdaui_raw_grid_class_init (GdauiRawGridClass *klass)
 	GObjectClass  *object_class = G_OBJECT_CLASS (klass);
 	parent_class = g_type_class_peek_parent (klass);
 
+	/**
+	 * GdauiRawGrid::double-clicked:
+	 * @grid: GdauiRawGrid
+	 * @row: the row that was double clicked
+	 *
+	 * Emitted when the user double clicks on a row
+	 */
 	gdaui_raw_grid_signals[DOUBLE_CLICKED] =
 		g_signal_new ("double-clicked",
                               G_TYPE_FROM_CLASS (object_class),
@@ -268,6 +275,14 @@ gdaui_raw_grid_class_init (GdauiRawGridClass *klass)
                               NULL, NULL,
                               _gdaui_marshal_VOID__INT, G_TYPE_NONE,
                               1, G_TYPE_INT);
+
+	/**
+	 * GdauiRawGrid::populate-popup:
+	 * @grid: GdauiRawGrid
+	 * @menu: a #GtkMenu to modify
+	 *
+	 * Connect this signal and modify the popup menu.
+	 */
 	gdaui_raw_grid_signals[POPULATE_POPUP] =
 		g_signal_new ("populate-popup",
                               G_TYPE_FROM_CLASS (object_class),
diff --git a/libgda/gda-meta-struct.h b/libgda/gda-meta-struct.h
index 1bdfec0..ae4843c 100644
--- a/libgda/gda-meta-struct.h
+++ b/libgda/gda-meta-struct.h
@@ -175,9 +175,11 @@ typedef struct {
  * Struture to hold information about each database object (tables, views, ...),
  * its contents must not be modified.
  *
- * Note: @obj_catalog, @obj_schema, @obj_name, @obj_short_name and @obj_full_name are case sensitive:
- *       one must use gda_sql_identifier_quote() to know if is it is necessary to surround by double quotes
- *       before using in an SQL statement
+ * Note: @obj_catalog, @obj_schema, @obj_name, @obj_short_name and @obj_full_name respect the
+ * <link linkend="information_schema:sql_identifiers">SQL identifiers</link> convention used in
+ * #GdaMetaStore objects. Before using these SQL identifiers, you should check the
+ * gda_sql_identifier_quote() to know if is it is necessary to surround by double quotes
+ * before using in an SQL statement.
  */
 typedef struct {
 	/*< public >*/
@@ -194,7 +196,7 @@ typedef struct {
 	gchar                  *obj_full_name;
 	gchar                  *obj_owner;
 
-	GSList                 *depend_list; /* list of GdaMetaDbObject pointers on which this object depends */
+	GSList                 *depend_list;
 
 	/*< private >*/
 	/* Padding for future expansion */