[gnome-db] [PATCH] - add some commentaries in libgnomedb/gnome-db-grid.c

[Stephane Wirtel <stephane wirtel brutele be>]

Hi all, 

It's a very small patch for libgnomedb :-).

I add some commentaries in the source code of gnome-db-grid.c
It's for the documentation.

Bye, 


Stephane aka matrixise

Index: ChangeLog
===================================================================
RCS file: /cvs/gnome/libgnomedb/ChangeLog,v
retrieving revision 1.279
diff -u -r1.279 ChangeLog
--- ChangeLog	5 Jan 2004 19:20:00 -0000	1.279
+++ ChangeLog	6 Jan 2004 02:19:57 -0000
@@ -1,3 +1,7 @@
+2004-01-06  Stephane Wirtel <stephane wirtel brutele be>
+
+	* libgnomedb/libgnomedb.c: add some commentaries.
+	
 2004-01-05  Laurent Sansonetti <lrz gnome org>
 
 	* control-center/database-properties.desktop.in:
Index: libgnomedb/gnome-db-grid.c
===================================================================
RCS file: /cvs/gnome/libgnomedb/libgnomedb/gnome-db-grid.c,v
retrieving revision 1.53
diff -u -r1.53 gnome-db-grid.c
--- libgnomedb/gnome-db-grid.c	4 Jan 2004 21:07:12 -0000	1.53
+++ libgnomedb/gnome-db-grid.c	6 Jan 2004 02:19:57 -0000
@@ -720,6 +720,10 @@
 
 /**
  * gnome_db_grid_new
+ * 
+ * Create a #GnomeDbGrid.
+ *
+ * Returns: a GtkWidget widget.
  */
 GtkWidget *
 gnome_db_grid_new (void)
@@ -732,6 +736,11 @@
 
 /**
  * gnome_db_grid_new_with_model
+ * @model: a #GdaDataModel variable.
+ * 
+ * Create a #GnomeDbGrid with a #GdaDataModel.
+ *
+ * Returns: a GtkWidget widget.
  */
 GtkWidget *
 gnome_db_grid_new_with_model (GdaDataModel *model)
@@ -932,6 +941,11 @@
 
 /**
  * gnome_db_grid_get_model
+ * @grid: a #GnomeDbGrid widget.
+ *
+ * Retrieve the #GdaDataModel associated with this #GnomeDbGrid.
+ * 
+ * Returns: a #GdaDataModel widget.
  */
 GdaDataModel *
 gnome_db_grid_get_model (GnomeDbGrid *grid)
@@ -947,6 +961,10 @@
 
 /**
  * gnome_db_grid_set_model
+ * @grid: a #GnomeDbGrid widget.
+ * @model: a #GdaDataModel widget.
+ *
+ * Set the new model for the given grid.
  */
 void
 gnome_db_grid_set_model (GnomeDbGrid *grid, GdaDataModel *model)
@@ -1049,6 +1067,9 @@
 
 /**
  * gnome_db_grid_select_all
+ * @grid: a #GnomeDbGrid widget.
+ *
+ * Select all rows in the #GnomeDbGrid widget.
  */
 void
 gnome_db_grid_select_all (GnomeDbGrid *grid)
@@ -1064,6 +1085,9 @@
 
 /**
  * gnome_db_grid_unselect_all
+ * @grid: a #GnomeDbGrid widget.
+ * 
+ * Unselect all rows of the #GnomeDbGrid widget.
  */
 void
 gnome_db_grid_unselect_all (GnomeDbGrid *grid)
@@ -1078,6 +1102,11 @@
 
 /**
  * gnome_db_grid_get_selection_mode
+ * @grid: a #GnomeDbGrid widget.
+ *
+ * Retrieve the selection mode of a #GnomeDbGrid widget.
+ *
+ * Returns: a GtkSelectionMode widget.
  */
 GtkSelectionMode
 gnome_db_grid_get_selection_mode (GnomeDbGrid *grid)
@@ -1092,6 +1121,10 @@
 
 /**
  * gnome_db_set_selection_mode
+ * @grid: a #GnomeDbGrid widget.
+ * @mode: a GtkSelectionMode widget.
+ * 
+ * Set the new selection mode for this #GnomeDbGrid widget.
  */
 void
 gnome_db_grid_set_selection_mode (GnomeDbGrid *grid, GtkSelectionMode mode)
@@ -1108,6 +1141,10 @@
 
 /**
  * gnome_db_grid_set_column_titles_visible
+ * @grid: a #GnomeDbGrid widget.
+ * @visible: a gboolean.
+ * 
+ * Hide or Show the titles of the #GnomeDbGrid widget.
  */
 void
 gnome_db_grid_set_column_titles_visible (GnomeDbGrid *grid, gboolean visible)
@@ -1118,6 +1155,9 @@
 
 /**
  * gnome_db_grid_get_column_titles_visible
+ * @grid: a #GnomeDbGrid widget.
+ *
+ * Retrieve a gboolean ( TRUE or FALSE ).
  */
 gboolean
 gnome_db_grid_get_column_titles_visible (GnomeDbGrid *grid)