[libgda] Doc. improvements
- From: Vivien Malerba <vivien src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgda] Doc. improvements
- Date: Tue, 12 Jul 2011 19:22:48 +0000 (UTC)
commit 1bdf06cf13fb3da252ca2d3433813375221bb871
Author: Vivien Malerba <malerba gnome-db org>
Date: Tue Jul 12 20:44:03 2011 +0200
Doc. improvements
doc/C/gettingstarted.xml | 2 +-
doc/C/howto.xml | 2 +-
doc/C/libgda-sections.txt | 6 ------
libgda-ui/gdaui-init.c | 1 +
libgda-ui/gdaui-plugin.h | 26 ++++++++++++--------------
5 files changed, 15 insertions(+), 22 deletions(-)
---
diff --git a/doc/C/gettingstarted.xml b/doc/C/gettingstarted.xml
index b4af31e..c41d768 100644
--- a/doc/C/gettingstarted.xml
+++ b/doc/C/gettingstarted.xml
@@ -58,7 +58,7 @@ main (int argc, char **argv)
<para>
&LIBGDA; allows data sources (DSN) to be defined and referred to by a unique name which contains all the
required information to actually open a connection (except the name and password if they are required);
- see the <link linkend="libgda-40-Configuration">Configuration section</link> for more information about
+ see the <link linkend="libgda-5.0-Configuration">Configuration section</link> for more information about
how to manage data sources. Of
course it's still possible to open a connection without having defined a DSN, in which case a <emphasis>connection
string</emphasis> is used to specify all the parameters required to open a connection. For more information
diff --git a/doc/C/howto.xml b/doc/C/howto.xml
index 4be53ee..10a7213 100644
--- a/doc/C/howto.xml
+++ b/doc/C/howto.xml
@@ -41,7 +41,7 @@ else {
<sect1>
<title>Define a data source (DSN)</title>
<para>
- The <link linkend="libgda-40-Configuration">Configuration section</link> details how to manage data sources
+ The <link linkend="libgda-5.0-Configuration">Configuration section</link> details how to manage data sources
definitions. To define a data source, one needs to create and fill a
<link linkend="GdaDsnInfo">GdaDsnInfo</link> structure, and use the
<link linkend="gda-config-define-dsn">gda_config_define_dsn()</link> function.
diff --git a/doc/C/libgda-sections.txt b/doc/C/libgda-sections.txt
index 4eaf272..19ba9d4 100644
--- a/doc/C/libgda-sections.txt
+++ b/doc/C/libgda-sections.txt
@@ -247,7 +247,6 @@ gda_ldap_connection_get_base_dn
gda_ldap_connection_declare_table
gda_ldap_connection_undeclare_table
<SUBSECTION>
-gda_ldap_dn_split
GdaLdapAttribute
GdaLdapEntry
gda_ldap_is_dn
@@ -835,7 +834,6 @@ gda_value_free
gda_value_new_from_string
gda_value_set_from_string
gda_value_set_from_value
-gda_value_set_null
gda_value_stringify
gda_value_differ
gda_value_compare
@@ -873,10 +871,6 @@ gda_geometricpoint_free
gda_value_get_geometric_point
gda_value_set_geometric_point
<SUBSECTION>
-GdaValueList
-gda_value_get_list
-gda_value_set_list
-<SUBSECTION>
GdaNumeric
gda_numeric_copy
gda_numeric_free
diff --git a/libgda-ui/gdaui-init.c b/libgda-ui/gdaui-init.c
index b814f11..2c1877c 100644
--- a/libgda-ui/gdaui-init.c
+++ b/libgda-ui/gdaui-init.c
@@ -755,6 +755,7 @@ gdaui_get_default_path (void)
/**
* gdaui_set_default_path:
+ * @path: (allow-none): a path, or %NULL to unset
*
* Define the default path used when saving a file, or when showing a #GtkFileChooser file chooser.
*
diff --git a/libgda-ui/gdaui-plugin.h b/libgda-ui/gdaui-plugin.h
index dc28d35..3b4cdea 100644
--- a/libgda-ui/gdaui-plugin.h
+++ b/libgda-ui/gdaui-plugin.h
@@ -27,10 +27,10 @@
/**
* GdauiEntryCreateFunc:
- * @Param1:
- * @Param2:
- * @Param3:
- * @Returns:
+ * @Param1: a #GdaDataHandler
+ * @Param2: a #GType
+ * @Param3: options, or %NULL
+ * @Returns: a new #GdauiDataEntry
*
* Defines a function which creates a #GdauiDataEntry widget
*/
@@ -38,10 +38,10 @@ typedef GdauiDataEntry *(*GdauiEntryCreateFunc)(GdaDataHandler *, GType, const
/**
* GdauiCellCreateFunc:
- * @Param1:
- * @Param2:
- * @Param3:
- * @Returns:
+ * @Param1: a #GdaDataHandler
+ * @Param2: a #GType
+ * @Param3: options, or %NULL
+ * @Returns:a new #GtkCellRenderer
*
* Defines a function which creates a #GtkCellRenderer object
*/
@@ -54,8 +54,7 @@ typedef GtkCellRenderer *(*GdauiCellCreateFunc) (GdaDataHandler *, GType, const
* @plugin_descr: a description for the plugin, or %NULL
* @plugin_file: the shared object implementing the plugin, can be %NULL for internal plugins
* @nb_g_types: number of types the plugin can handle, or %0 for any type
- * @valid_g_types: an array of #GType, containing the accepted types, its size is @nb_g_types,
- * or %NULL if @nb_g_types is %0
+ * @valid_g_types: an array of #GType, containing the accepted types, its size is @nb_g_types, or %NULL if @nb_g_types is %0
* @options_xml_spec: a string describing the plugin's options, or %NULL
* @entry_create_func: the function called to create a #GdauiDataEntry, or %NULL
* @cell_create_func: the function called to create a #GtkCellRenderer, or %NULL
@@ -74,14 +73,13 @@ typedef struct {
gchar *options_xml_spec; /* NULL if no option possible */
- /* actual widget creation: one of them must be not NULL */
- GdauiEntryCreateFunc entry_create_func;
- GdauiCellCreateFunc cell_create_func;
+ GdauiEntryCreateFunc entry_create_func;
+ GdauiCellCreateFunc cell_create_func;
} GdauiPlugin;
/**
* SECTION:gdaui-plugins
- * @short_description:
+ * @short_description: Plugin to customize dana entry widgets and call renderers in tree views
* @title: UI plugins
* @stability: Stable
* @Image:
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]