Gtk-doc adjustments.

diff --git a/.gitignore b/.gitignore
index 6a2c9e638367b142ea284258b2bfde343de53905..3f0aeda4c8acc25ef585835f6b009d714bb2c80a 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -37,6 +37,14 @@ m4/
 missing
 config.h
 config.status
+docs/reference/libgdaexgrid-undeclared.txt
+docs/reference/libgdaexgrid-undocumented.txt
+docs/reference/libgdaexgrid-unused.txt
+docs/reference/libgdaexgrid.args
+docs/reference/libgdaexgrid.hierarchy
+docs/reference/libgdaexgrid.interfaces
+docs/reference/libgdaexgrid.prerequisites
+docs/reference/libgdaexgrid.signals
 docs/reference/version.xml
 docs/reference/html/
 docs/reference/xml/

diff --git a/Makefile.am b/Makefile.am
index 1dbf6f9ae73a8283c357c6782d923d6320b235cf..8105922ce03d687999f34f964163f30b239c6db3 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,3 +1,5 @@
+DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc
+
 SUBDIRS = po src tests docs
 
 ACLOCAL_AMFLAGS = -I m4

diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 4d4430aac345958742ac25d4b41cd647a77002f3..c056db645d5f4c9e78fe9da7d203c18b1a4aa7eb 100644 (file)
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -67,8 +67,8 @@ expand_content_files=
 # signals and properties.
 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-GTKDOC_CFLAGS=
-GTKDOC_LIBS=
+GTKDOC_CFLAGS=-I$(top_srcdir)/src -I$(top_builddir)/src $(GTK_DEBUG_FLAGS)
+GTKDOC_LIBS=$(top_builddir)/src/libgdaexgrid.la
 
 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 include $(top_srcdir)/gtk-doc.make

diff --git a/docs/reference/libgdaexgrid-docs.xml b/docs/reference/libgdaexgrid-docs.xml
index a77c78fe4fb39495cb86fbb3e5a1eef4bbf0cfb2..dd2e23bb83587e5125cfd3dc96412c8d34e71c19 100644 (file)
--- a/docs/reference/libgdaexgrid-docs.xml
+++ b/docs/reference/libgdaexgrid-docs.xml
@@ -17,9 +17,9 @@
   </bookinfo>
 
   <chapter>
-    <title>[Insert title here]</title>
-        <xi:include href="xml/grid.xml"/>
-    <xi:include href="xml/gridcolumn.xml"/>
+    <title>GdaExGrid</title>
+        <xi:include href="xml/gdaexgrid.xml"/>
+    <xi:include href="xml/gdaexgridcolumn.xml"/>
 
   </chapter>
   <chapter id="object-tree">

diff --git a/docs/reference/libgdaexgrid-sections.txt b/docs/reference/libgdaexgrid-sections.txt
index 436231c3a610c8242f92c0a56f44315ef0bcc3a2..c797c92d3a64e1e09e21d3b26ef1310b50c112c4 100644 (file)
--- a/docs/reference/libgdaexgrid-sections.txt
+++ b/docs/reference/libgdaexgrid-sections.txt
@@ -1,5 +1,6 @@
 <SECTION>
-<FILE>grid</FILE>
+<FILE>gdaexgrid</FILE>
+<TITLE>GdaExGrid</TITLE>
 <SUBSECTION Standard>
 GDAEX_GRID
 GDAEX_GRID_CLASS
@@ -12,7 +13,8 @@ GdaExGridClass
 </SECTION>
 
 <SECTION>
-<FILE>gridcolumn</FILE>
+<FILE>gdaexgridcolumn</FILE>
+<TITLE>GdaExGridColumn</TITLE>
 <SUBSECTION Standard>
 GDAEX_GRID_COLUMN
 GDAEX_GRID_COLUMN_CLASS
@@ -23,4 +25,3 @@ GDAEX_TYPE_GRID_COLUMN
 GdaExGridColumn
 GdaExGridColumnClass
 </SECTION>
-

diff --git a/docs/reference/libgdaexgrid-undeclared.txt b/docs/reference/libgdaexgrid-undeclared.txt
deleted file mode 100644 (file)
index e69de29..0000000

diff --git a/docs/reference/libgdaexgrid-undocumented.txt b/docs/reference/libgdaexgrid-undocumented.txt
deleted file mode 100644 (file)
index 96662e5..0000000
--- a/docs/reference/libgdaexgrid-undocumented.txt
+++ /dev/null
@@ -1,29 +0,0 @@
-0% symbol docs coverage.
-0 symbols documented.
-0 symbols incomplete.
-22 not documented.
-
-
-gdaex_grid_column_get_column
-gdaex_grid_column_get_decimals
-gdaex_grid_column_get_field_name
-gdaex_grid_column_get_reorderable
-gdaex_grid_column_get_resizable
-gdaex_grid_column_get_sortable
-gdaex_grid_column_get_title
-gdaex_grid_column_get_type
-gdaex_grid_column_get_visible
-gdaex_grid_column_new
-gdaex_grid_column_set_decimals
-gdaex_grid_column_set_field_name
-gdaex_grid_column_set_gtype
-gdaex_grid_column_set_reorderable
-gdaex_grid_column_set_resizable
-gdaex_grid_column_set_sortable
-gdaex_grid_column_set_visible
-gdaex_grid_columns_set_title
-
-grid:Long_Description
-grid:Short_Description
-gridcolumn:Long_Description
-gridcolumn:Short_Description

diff --git a/docs/reference/libgdaexgrid-unused.txt b/docs/reference/libgdaexgrid-unused.txt
deleted file mode 100644 (file)
index e69de29..0000000

diff --git a/docs/reference/libgdaexgrid.args b/docs/reference/libgdaexgrid.args
deleted file mode 100644 (file)
index e69de29..0000000

diff --git a/docs/reference/libgdaexgrid.hierarchy b/docs/reference/libgdaexgrid.hierarchy
deleted file mode 100644 (file)
index e69de29..0000000

diff --git a/docs/reference/libgdaexgrid.interfaces b/docs/reference/libgdaexgrid.interfaces
deleted file mode 100644 (file)
index e69de29..0000000

diff --git a/docs/reference/libgdaexgrid.prerequisites b/docs/reference/libgdaexgrid.prerequisites
deleted file mode 100644 (file)
index e69de29..0000000

diff --git a/docs/reference/libgdaexgrid.signals b/docs/reference/libgdaexgrid.signals
deleted file mode 100644 (file)
index e69de29..0000000

diff --git a/docs/reference/libgdaexgrid.types b/docs/reference/libgdaexgrid.types
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..e27267d941dbc277a2b82926e74fda7e87fdc5e9 100644 (file)
--- a/docs/reference/libgdaexgrid.types
+++ b/docs/reference/libgdaexgrid.types
@@ -0,0 +1,2 @@
+gdaex_grid_get_type
+gdaex_grid_column_get_type
\ No newline at end of file

diff --git a/src/grid.c b/src/grid.c
index 5cce9be83aa7cc94c6cdfe7e25e56991699bebab..4be7d1e1f4066a0b2b26b24c153fae1794b86c17 100644 (file)
--- a/src/grid.c
+++ b/src/grid.c
@@ -1,7 +1,7 @@
 /*
  *  grid.c
  *
- *  Copyright (C) 2010-2016 Andrea Zagli <azagli@libero.it>
+ *  Copyright (C) 2010-2017 Andrea Zagli <azagli@libero.it>
  *
  *  This file is part of libgdaexgrid.
  *
@@ -147,6 +147,13 @@ gdaex_grid_init (GdaExGrid *gdaex_grid)
        priv->app_textdomain = NULL;
 }
 
+/**
+ * gdaex_grid_new:
+ *
+ * Creates the #GdaExGrid object.
+ *
+ * Returns: a new #GdaExGrid object.
+ */
 GdaExGrid
 *gdaex_grid_new ()
 {
@@ -192,6 +199,13 @@ GdaExGrid
        return gdaex_grid;
 }
 
+/**
+ * gdaex_grid_set_app_textdomain:
+ * @grid: a #GdaExGrid object.
+ * @textdomain:
+ *
+ * Sets the textdomain.
+ */
 void
 gdaex_grid_set_app_textdomain (GdaExGrid *grid, const gchar *textdomain)
 {
@@ -208,6 +222,13 @@ gdaex_grid_set_app_textdomain (GdaExGrid *grid, const gchar *textdomain)
        priv->app_textdomain = g_strdup (textdomain);
 }
 
+/**
+ * gdaex_grid_set_title:
+ * @grid: a #GdaExGrid object.
+ * @title: the grid's title.
+ *
+ * Sets the grid's title.
+ */
 void
 gdaex_grid_set_title (GdaExGrid *grid, const gchar *title)
 {
@@ -232,6 +253,14 @@ gdaex_grid_set_title (GdaExGrid *grid, const gchar *title)
                }
 }
 
+/**
+ * gdaex_grid_get_title:
+ * @grid: a #GdaExGrid object.
+ *
+ * Gets the grid's title.
+ *
+ * Returns: the grid's title.
+ */
 const gchar
 *gdaex_grid_get_title (GdaExGrid *grid)
 {
@@ -251,6 +280,13 @@ const gchar
                }
 }
 
+/**
+ * gdaex_grid_add_column:
+ * @grid: a #GdaExGrid object.
+ * @column: a #GdaExGridColumn object.
+ *
+ * Adds a column to the grid.
+ */
 void
 gdaex_grid_add_column (GdaExGrid *grid, GdaExGridColumn *column)
 {
@@ -264,6 +300,13 @@ gdaex_grid_add_column (GdaExGrid *grid, GdaExGridColumn *column)
        g_ptr_array_add (priv->columns, g_object_ref (column));
 }
 
+/**
+ * gdaex_grid_add_columns:
+ * @grid: a #GdaExGrid object.
+ * @columns: a #GSList of #GdaExGridColumn objects.
+ *
+ * Adds columns to the grid.
+ */
 void
 gdaex_grid_add_columns (GdaExGrid *grid, GSList *columns)
 {
@@ -279,6 +322,12 @@ gdaex_grid_add_columns (GdaExGrid *grid, GSList *columns)
                }
 }
 
+/**
+ * gdaex_grid_clear:
+ * @grid: a #GdaExGrid object.
+ *
+ * Clears the grid object.
+ */
 void
 gdaex_grid_clear (GdaExGrid *grid)
 {
@@ -301,6 +350,14 @@ gdaex_grid_clear (GdaExGrid *grid)
        priv->columns = g_ptr_array_new ();
 }
 
+/**
+ * gdaex_grid_get_widget:
+ * @grid: a #GdaExGrid object.
+ *
+ * Gets the #GtkWidget of the grid.
+ *
+ * Returns: the #GtkWidget of the grid.
+ */
 GtkWidget
 *gdaex_grid_get_widget (GdaExGrid *grid)
 {
@@ -327,6 +384,20 @@ const gchar *_gettext (const gchar *str)
                }
 }
 
+/**
+ * gdaex_grid_fill_from_sql_with_missing_func_with_sel:
+ * @grid: a #GdaExGrid object.
+ * @gdaex: a #GdaEx object.
+ * @sql: the sql statement to use as datasource.
+ * @missing_func:
+ * @user_data:
+ * @ht_sel:
+ * @error: where return errors.
+ *
+ * Fills the grid.
+ *
+ * Returns: TRUE if success.
+ */
 gboolean
 gdaex_grid_fill_from_sql_with_missing_func_with_sel (GdaExGrid *grid,
                                                                                                         GdaEx *gdaex,
@@ -357,6 +428,19 @@ gdaex_grid_fill_from_sql_with_missing_func_with_sel (GdaExGrid *grid,
        return ret;
 }
 
+/**
+ * gdaex_grid_fill_from_datamodel_with_missing_func_with_sel:
+ * @grid: a #GdaExGrid object.
+ * @dm: a #GdaDataModel object to use as datasource.
+ * @missing_func:
+ * @user_data:
+ * @ht_sel:
+ * @error: where return errors.
+ *
+ * Fills the grid.
+ *
+ * Returns: TRUE if success.
+ */
 gboolean
 gdaex_grid_fill_from_datamodel_with_missing_func_with_sel (GdaExGrid *grid,
                                                                                                                   GdaDataModel *dm,
@@ -661,6 +745,20 @@ gdaex_grid_fill_from_datamodel_with_missing_func_with_sel (GdaExGrid *grid,
        return TRUE;
 }
 
+/**
+ * gdaex_grid_fill_from_sqlbuilder_with_missing_func_with_sel:
+ * @grid: a #GdaExGrid object.
+ * @gdaex: a #GdaEx object.
+ * @builder:
+ * @missing_func:
+ * @user_data:
+ * @ht_sel:
+ * @error: where return errors.
+ *
+ * Fills the grid.
+ *
+ * Returns: TRUE if success.
+ */
 gboolean
 gdaex_grid_fill_from_sqlbuilder_with_missing_func_with_sel (GdaExGrid *grid,
                                                                                                                        GdaEx *gdaex,
@@ -684,6 +782,19 @@ gdaex_grid_fill_from_sqlbuilder_with_missing_func_with_sel (GdaExGrid *grid,
        return ret;
 }
 
+/**
+ * gdaex_grid_fill_from_sql_with_missing_func:
+ * @grid: a #GdaExGrid object.
+ * @gdaex: a #GdaEx object.
+ * @sql: the sql statement to use as datasource.
+ * @missing_func:
+ * @user_data:
+ * @error: where return errors.
+ *
+ * Fills the grid.
+ *
+ * Returns: TRUE if success.
+ */
 gboolean
 gdaex_grid_fill_from_sql_with_missing_func (GdaExGrid *grid,
                                             GdaEx *gdaex,
@@ -713,6 +824,18 @@ gdaex_grid_fill_from_sql_with_missing_func (GdaExGrid *grid,
        return ret;
 }
 
+/**
+ * gdaex_grid_fill_from_datamodel_with_missing_func:
+ * @grid: a #GdaExGrid object.
+ * @dm: a #GdaDataModel object to use as datasource.
+ * @missing_func:
+ * @user_data:
+ * @error: where return errors.
+ *
+ * Fills the grid.
+ *
+ * Returns: TRUE if success.
+ */
 gboolean
 gdaex_grid_fill_from_datamodel_with_missing_func (GdaExGrid *grid,
                                                   GdaDataModel *dm,
@@ -722,6 +845,19 @@ gdaex_grid_fill_from_datamodel_with_missing_func (GdaExGrid *grid,
        return gdaex_grid_fill_from_datamodel_with_missing_func_with_sel (grid, dm, missing_func, user_data, NULL, error);
 }
 
+/**
+ * gdaex_grid_fill_from_sqlbuilder_with_missing_func:
+ * @grid: a #GdaExGrid object.
+ * @gdaex: a #GdaEx object.
+ * @builder: a #GdaExSqlBuilder object.
+ * @missing_func:
+ * @user_data:
+ * @error: where return errors.
+ *
+ * Fills the grid.
+ *
+ * Returns: TRUE if success.
+ */
 gboolean
 gdaex_grid_fill_from_sqlbuilder_with_missing_func (GdaExGrid *grid,
                                                    GdaEx *gdaex,
@@ -744,18 +880,50 @@ gdaex_grid_fill_from_sqlbuilder_with_missing_func (GdaExGrid *grid,
        return ret;
 }
 
+/**
+ * gdaex_grid_fill_from_sql:
+ * @grid: a #GdaExGrid object.
+ * @gdaex: a #GdaEx object.
+ * @sql: the sql statement to use as datasource.
+ * @error: where return errors.
+ *
+ * Fills the grid.
+ *
+ * Returns: TRUE if success.
+ */
 gboolean
 gdaex_grid_fill_from_sql (GdaExGrid *grid, GdaEx *gdaex, const gchar *sql, GError **error)
 {
        return gdaex_grid_fill_from_sql_with_missing_func (grid, gdaex, sql, NULL, NULL, error);
 }
 
+/**
+ * gdaex_grid_fill_from_datamodel:
+ * @grid: a #GdaExGrid object.
+ * @dm: a #GdaDataModel to use as datasource.
+ * @error: where return errors.
+ *
+ * Fills the grid.
+ *
+ * Returns: TRUE if success.
+ */
 gboolean
 gdaex_grid_fill_from_datamodel (GdaExGrid *grid, GdaDataModel *dm, GError **error)
 {
        return gdaex_grid_fill_from_datamodel_with_missing_func (grid, dm, NULL, NULL, error);
 }
 
+/**
+ * gdaex_grid_fill_from_sqlbuilder:
+ * @grid: a #GdaExGrid object.
+ * @gdaex: a #GdaEx object.
+ * @builder: a #GdaExSqlBuilder object to use as datasource.
+ * @error: where return errors.
+ *
+ * Fills the grid.
+ *
+ * Returns: TRUE if success.
+ */
 gboolean
 gdaex_grid_fill_from_sqlbuilder (GdaExGrid *grid, GdaEx *gdaex, GdaExSqlBuilder *builder, GError **error)
 {
@@ -763,6 +931,13 @@ gdaex_grid_fill_from_sqlbuilder (GdaExGrid *grid, GdaEx *gdaex, GdaExSqlBuilder
 }
 
 #ifdef SOLIPA_FOUND
+/**
+ * gdaex_grid_set_solipa:
+ * @grid: a #GdaExGrid object.
+ * @solipa: a #Solipa object.
+ *
+ * Sets the #Solipa object.
+ */
 void
 gdaex_grid_set_solipa (GdaExGrid *grid, Solipa *solipa)
 {

diff --git a/src/gridcolumn.c b/src/gridcolumn.c
index 9a572bbe8e103101acee93c14f445d90b605006d..3024673621d40447c93a6973cc4423b975334e95 100644 (file)
--- a/src/gridcolumn.c
+++ b/src/gridcolumn.c
@@ -89,14 +89,14 @@ gdaex_grid_column_init (GdaExGridColumn *gdaex_grid_column)
 
 /**
  * gdaex_grid_column_new:
- * @title:
- * @field_name:
- * @type:
- * @visible:
- * @resizable:
- * @sortable:
- * @reorderable:
- * @decimals:
+ * @title: the column's title.
+ * @field_name: the column's field name.
+ * @type: the column's #Gtype.
+ * @visible: if column is visible.
+ * @resizable: is column is resizable.
+ * @sortable: if column is sortable.
+ * @reorderable: if column is reorderable.
+ * @decimals: number of decimals.
  *
  * Returns: a new #GdaExGridColumns object.
  */
@@ -126,6 +126,14 @@ GdaExGridColumn
        return gdaex_grid_column;
 }
 
+/**
+ * gdaex_grid_column_new_defaults:
+ * @title: the column's title.
+ * @field_name: the column's field name.
+ * @type: the column's #GType.
+ *
+ * Returns: a new #GdaExGridColumns object.
+ */
 GdaExGridColumn
 *gdaex_grid_column_new_defaults (const gchar *title,
                                  const gchar *field_name,