[libgda] Added gdaui_init() to the documentation



commit 7527e59bea4011f4963bdb2473f8148b1dfa67a2
Author: Vivien Malerba <malerba gnome-db org>
Date:   Tue Jan 19 21:54:36 2010 +0100

    Added gdaui_init() to the documentation

 doc/C/libgda-4.0-docs.sgml   |    2 ++
 doc/C/libgda-ui-sections.txt |    7 +++++++
 libgda-ui/gdaui-init.c       |   10 +++++++++-
 3 files changed, 18 insertions(+), 1 deletions(-)
---
diff --git a/doc/C/libgda-4.0-docs.sgml b/doc/C/libgda-4.0-docs.sgml
index 91ab87d..6442c5a 100644
--- a/doc/C/libgda-4.0-docs.sgml
+++ b/doc/C/libgda-4.0-docs.sgml
@@ -60,6 +60,7 @@
 <!ENTITY libgda-GdaConnection-event SYSTEM "xml/gda-connection-event.xml">
 <!ENTITY libgda-GdaColumn SYSTEM "xml/gda-column.xml">
 <!ENTITY libgda-init SYSTEM "xml/libgda.xml">
+<!ENTITY libgdaui-init SYSTEM "xml/libgdaui.xml">
 <!ENTITY libgda-log SYSTEM "xml/gda-log.xml">
 <!ENTITY libgda-quark-list SYSTEM "xml/gda-quark-list.xml">
 <!ENTITY libgda-GdaServerProvider SYSTEM "xml/gda-server-provider.xml">
@@ -1247,6 +1248,7 @@ g_object_unref (store);
       <title>User interface API reference</title>
       &visual-index;
 
+      &libgdaui-init;
       &libgdaui-GdauiLogin;
       &libgdaui-GdauiProviderSelector;
 
diff --git a/doc/C/libgda-ui-sections.txt b/doc/C/libgda-ui-sections.txt
index 14e401d..035eccb 100644
--- a/doc/C/libgda-ui-sections.txt
+++ b/doc/C/libgda-ui-sections.txt
@@ -1,4 +1,11 @@
 <SECTION>
+<FILE>libgdaui</FILE>
+<TITLE>LibgdaUI Initialization</TITLE>
+gdaui_init
+<SUBSECTION Standard>
+</SECTION>
+
+<SECTION>
 <FILE>gdaui-easy</FILE>
 <TITLE>UI Utility functions</TITLE>
 gdaui_new_data_entry
diff --git a/libgda-ui/gdaui-init.c b/libgda-ui/gdaui-init.c
index 3626e14..e490765 100644
--- a/libgda-ui/gdaui-init.c
+++ b/libgda-ui/gdaui-init.c
@@ -51,7 +51,15 @@ GHashTable *gdaui_plugins_hash = NULL; /* key = plugin name, value = GdauiPlugin
  * gdaui_init
  *
  * Initialization of the libgda-ui library, must be called before any usage of the library.
- * Note: gtk_init() is not called by this function and should also be called.
+ *
+ * <itemizedlist>
+ * <listitem><para>Note1: gtk_init() is not called by this function and should also
+ *   be called (the calling order has no importance)</para></listitem>
+ * <listitem><para>Note2: this funtion also calls gda_init() so it should not be called
+ *    again</para></listitem>
+ * </itemizedlist>
+ *
+ * Since: 4.2
  */
 void
 gdaui_init (void)



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