[libgda: 1/2] gtk-doc: Fixing documentation for DB module

[Daniel Espinosa Ortiz <despinosa src gnome org>]

commit c9e229139d1a30e9261af95d9a6de8072886ed46
Author: Pavlo Solntsev <p sun fun gmail com>
Date:   Wed Nov 13 10:13:55 2019 -0600

    gtk-doc: Fixing documentation for DB module

 doc/C/libgda/libgda-6.0-sections.txt | 1 +
 libgda/gda-db-catalog.c              | 7 ++++---
 libgda/gda-db-table.c                | 8 ++++++--
 libgda/gda-db-table.h                | 2 +-
 4 files changed, 12 insertions(+), 6 deletions(-)
---
diff --git a/doc/C/libgda/libgda-6.0-sections.txt b/doc/C/libgda/libgda-6.0-sections.txt
index 4ff35db9f..914171801 100644
--- a/doc/C/libgda/libgda-6.0-sections.txt
+++ b/doc/C/libgda/libgda-6.0-sections.txt
@@ -124,6 +124,7 @@ gda_db_table_is_temp
 gda_db_table_set_temp
 gda_db_table_prepare_create
 gda_db_table_update
+gda_db_table_append_constraint
 </SECTION>
 
 <SECTION>
diff --git a/libgda/gda-db-catalog.c b/libgda/gda-db-catalog.c
index 5b6ab3362..baa40bdbb 100644
--- a/libgda/gda-db-catalog.c
+++ b/libgda/gda-db-catalog.c
@@ -380,7 +380,7 @@ on_error:
  * <!ELEMENT schema (table+, view*)>
  * <!ATTLIST schema name           CDATA   #IMPLIED>
  *
- * <!ELEMENT table (comment?,column+, fkey*)>
+ * <!ELEMENT table (comment?,column+, fkey*, constraint*)>
  * <!ATTLIST table temptable       (TRUE|FALSE)    "FALSE">
  * <!ATTLIST table name            CDATA           #REQUIRED>
  * <!ATTLIST table space           CDATA           #IMPLIED>
@@ -400,6 +400,8 @@ on_error:
  *
  * <!ELEMENT check         (#PCDATA)>
  *
+ * <!ELEMENT constraint    (#PCDATA)>
+ *
  * <!ELEMENT fkey (fk_field?)>
  * <!ATTLIST fkey reftable CDATA #IMPLIED>
  * <!ATTLIST fkey onupdate (RESTRICT|CASCADE|SET_NULL|NO_ACTION|SET_DEFAULT)       #IMPLIED>
@@ -419,8 +421,7 @@ on_error:
  * ]|
  *
  * Up to day description of the xml file schema can be found in DTD file
- * [libgda-db-catalog.dtd]
- * (https://gitlab.gnome.org/GNOME/libgda/blob/master/libgda/libgda-db-catalog.dtd)
+ * [libgda-db-catalog.dtd](https://gitlab.gnome.org/GNOME/libgda/blob/master/libgda/libgda-db-catalog.dtd)
  *
  * The given @xmlfile will be checked before parsing and %FALSE will be
  * returned if fails. The @xmlfile will be validated internally using
diff --git a/libgda/gda-db-table.c b/libgda/gda-db-table.c
index c44415ea1..0fd1d7b2a 100644
--- a/libgda/gda-db-table.c
+++ b/libgda/gda-db-table.c
@@ -797,10 +797,14 @@ gda_db_table_append_fkey (GdaDbTable *self,
 /**
  * gda_db_table_append_constraint:
  * @self: a #GdaDbTable instance
- * @constr a constraint string to append
+ * @constr: a constraint string to append
  *
- * Since: 6.0
+ * Append constraint expresion @constr to the table. This expresion will be used to create the table
+ * in the format:
+ *
+ * CREATE_TABLE &lt;table name&gt; (&lt;column description&gt;, CONSTRAINT @constr);
  *
+ * Since: 6.0
  */
 void
 gda_db_table_append_constraint (GdaDbTable *self,
diff --git a/libgda/gda-db-table.h b/libgda/gda-db-table.h
index 1085ce9ad..7821ffdfb 100644
--- a/libgda/gda-db-table.h
+++ b/libgda/gda-db-table.h
@@ -82,7 +82,7 @@ void            gda_db_table_append_fkey (GdaDbTable *self,
                                           GdaDbFkey *fkey);
 
 void            gda_db_table_append_constraint (GdaDbTable *self,
-                                                const gchar *constraint);
+                                                const gchar *constr);
 
 G_END_DECLS