[libgda/LIBGDA_4.0] GdaConfig, GdaConnection: Add docs about error domains thrown.

[Vivien Malerba <vivien src gnome org>]

commit 48278d50c6f7d387f2f7fe18b0eb9942dc88c666
Author: Vivien Malerba <malerba gnome-db org>
Date:   Sat Sep 11 17:51:40 2010 +0200

    GdaConfig, GdaConnection: Add docs about error domains thrown.

 libgda/gda-config.c     |   12 +++++++++---
 libgda/gda-connection.c |    8 +++++++-
 2 files changed, 16 insertions(+), 4 deletions(-)
---
diff --git a/libgda/gda-config.c b/libgda/gda-config.c
index d021b61..a19686d 100644
--- a/libgda/gda-config.c
+++ b/libgda/gda-config.c
@@ -853,7 +853,9 @@ gda_config_get_dsn_info (const gchar *dsn_name)
  * @info: a pointer to a filled GdaDsnInfo structure
  * @error: a place to store errors, or %NULL
  *
- * Add or update a DSN from the definition in @info
+ * Add or update a DSN from the definition in @info.
+ *
+ * This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigError error codes).
  *
  * Returns: TRUE if no error occurred
  */
@@ -936,7 +938,9 @@ gda_config_define_dsn (const GdaDsnInfo *info, GError **error)
  * @dsn_name: the name of the DSN to remove
  * @error: a place to store errors, or %NULL
  *
- * Add or update a DSN from the definition in @info
+ * Remove the DSN named @dsn_name.
+ *
+ * This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigError error codes).
  *
  * Returns: TRUE if no error occurred
  */
@@ -1175,7 +1179,9 @@ gda_config_get_provider_info (const gchar *provider_name)
  * provider named @provider_name. The caller must not call g_object_unref() on the
  * returned object.
  *
- * Returns: a pointer to the #GdaServerProvider, or %NULL if an error occurred
+ * This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigError error codes).
+ *
+ * Returns: (transfer none): a pointer to the #GdaServerProvider, or %NULL if an error occurred
  */
 GdaServerProvider *
 gda_config_get_provider (const gchar *provider_name, GError **error)
diff --git a/libgda/gda-connection.c b/libgda/gda-connection.c
index f184984..f95119b 100644
--- a/libgda/gda-connection.c
+++ b/libgda/gda-connection.c
@@ -652,6 +652,9 @@ gda_connection_get_property (GObject *object,
  * provider (use gda_config_get_provider_info() to get it). Also one can use the "gda-sql-4.0 -L" command to 
  * list the possible named parameters.
  *
+ * This method may fail with a GDA_CONNECTION_ERROR domain error (see the #GdaConnectionError error codes) 
+ * or a %GDA_CONFIG_ERROR domain error (see the #GdaConfigError error codes).
+ *
  * Returns: a new #GdaConnection if connection opening was sucessfull or %NULL if there was an error.
  */
 GdaConnection *
@@ -778,7 +781,10 @@ gda_connection_open_from_dsn (const gchar *dsn, const gchar *auth_string,
  * Additionally, it is possible to have the connection string
  * respect the "&lt;provider_name&gt;://&lt;real cnc string&gt;" format, in which case the provider name
  * and the real connection string will be extracted from that string (note that if @provider_name
- * is not %NULL then it will still be used as the provider ID).
+ * is not %NULL then it will still be used as the provider ID).\
+ *
+ * This method may fail with a GDA_CONNECTION_ERROR domain error (see the #GdaConnectionError error codes) 
+ * or a %GDA_CONFIG_ERROR domain error (see the #GdaConfigError error codes).
  *
  * Returns: a new #GdaConnection if connection opening was sucessfull or %NULL if there was an error.
  */