[libgda/LIBGDA_4.2] Doc. improvements
- From: Vivien Malerba <vivien src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgda/LIBGDA_4.2] Doc. improvements
- Date: Fri, 15 Jul 2011 14:38:00 +0000 (UTC)
commit aeb525cf9ff7cd91cc45a3d8328a40c6f6b6bcaf
Author: Vivien Malerba <malerba gnome-db org>
Date: Fri Jul 15 16:21:14 2011 +0200
Doc. improvements
doc/C/gettingstarted.xml | 2 +-
doc/C/howto.xml | 2 +-
libgda-ui/gdaui-init.c | 1 +
libgda-ui/gdaui-plugin.h | 27 ++++++++++++++++++++++-----
4 files changed, 25 insertions(+), 7 deletions(-)
---
diff --git a/doc/C/gettingstarted.xml b/doc/C/gettingstarted.xml
index 8ad2b87..445a378 100644
--- a/doc/C/gettingstarted.xml
+++ b/doc/C/gettingstarted.xml
@@ -53,7 +53,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-4.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 31b35aa..0439230 100644
--- a/doc/C/howto.xml
+++ b/doc/C/howto.xml
@@ -36,7 +36,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-4.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/libgda-ui/gdaui-init.c b/libgda-ui/gdaui-init.c
index cba385e..b2d5ef3 100644
--- a/libgda-ui/gdaui-init.c
+++ b/libgda-ui/gdaui-init.c
@@ -756,6 +756,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 d454128..33ac767 100644
--- a/libgda-ui/gdaui-plugin.h
+++ b/libgda-ui/gdaui-plugin.h
@@ -25,7 +25,26 @@
#include <libgda-ui/gdaui-data-entry.h>
#include "gdaui-decl.h"
+/**
+ * GdauiEntryCreateFunc:
+ * @Param1: a #GdaDataHandler
+ * @Param2: a #GType
+ * @Param3: options, or %NULL
+ * @Returns: a new #GdauiDataEntry
+ *
+ * Defines a function which creates a #GdauiDataEntry widget
+ */
typedef GdauiDataEntry *(*GdauiEntryCreateFunc)(GdaDataHandler *, GType, const gchar *);
+
+/**
+ * GdauiCellCreateFunc:
+ * @Param1: a #GdaDataHandler
+ * @Param2: a #GType
+ * @Param3: options, or %NULL
+ * @Returns:a new #GtkCellRenderer
+ *
+ * Defines a function which creates a #GtkCellRenderer object
+ */
typedef GtkCellRenderer *(*GdauiCellCreateFunc) (GdaDataHandler *, GType, const gchar *);
@@ -35,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
@@ -55,9 +73,8 @@ 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;
void gdaui_plugin_declare (const GdauiPlugin *plugin);
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]