[libgda/LIBGDA_4.2] GI: Improvements to GdaConnection annotations



commit a247aa35656d98a10124f9759a11836574f82a57
Author: Daniel Espinosa <despinosa src gnome org>
Date:   Tue Oct 18 14:33:28 2011 -0500

    GI: Improvements to GdaConnection annotations

 libgda/gda-connection.c |   42 +++++++++++++++++++++---------------------
 1 files changed, 21 insertions(+), 21 deletions(-)
---
diff --git a/libgda/gda-connection.c b/libgda/gda-connection.c
index 147236e..afcb772 100644
--- a/libgda/gda-connection.c
+++ b/libgda/gda-connection.c
@@ -1049,7 +1049,7 @@ _gda_connection_get_internal_thread_provider (void)
  * 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: (transfer full) (allow-none): a new #GdaConnection if connection opening was sucessfull or %NULL if there was an error.
+ * Returns: (transfer full): a new #GdaConnection if connection opening was sucessfull or %NULL if there was an error.
  */
 GdaConnection *
 gda_connection_open_from_dsn (const gchar *dsn, const gchar *auth_string, 
@@ -1159,9 +1159,9 @@ gda_connection_open_from_dsn (const gchar *dsn, const gchar *auth_string,
 
 /**
  * gda_connection_open_from_string:
- * @provider_name: provider ID to connect to, or %NULL
+ * @provider_name: (allow-none): provider ID to connect to, or %NULL
  * @cnc_string: connection string.
- * @auth_string: authentication string, or %NULL
+ * @auth_string: (allow-none): authentication string, or %NULL
  * @options: options for the connection (see #GdaConnectionOptions).
  * @error: a place to store an error, or %NULL
  *
@@ -1203,7 +1203,7 @@ gda_connection_open_from_dsn (const gchar *dsn, const gchar *auth_string,
  * 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: (transfer full) (allow-none): a new #GdaConnection if connection opening was sucessfull or %NULL if there was an error.
+ * Returns: (transfer full): a new #GdaConnection if connection opening was sucessfull or %NULL if there was an error.
  */
 GdaConnection *
 gda_connection_open_from_string (const gchar *provider_name, const gchar *cnc_string, const gchar *auth_string,
@@ -1377,7 +1377,7 @@ sqlite_connection_closed_cb (GdaConnection *cnc, G_GNUC_UNUSED gpointer data)
  * to be used by database providers which need a temporary database to store
  * some information.
  *
- * Returns: (transfer full) (allow-none): a new #GdaConnection, or %NULL if an error occurred
+ * Returns: (transfer full): a new #GdaConnection, or %NULL if an error occurred
  */
 GdaConnection *
 gda_connection_open_sqlite (const gchar *directory, const gchar *filename, gboolean auto_unlink)
@@ -2322,7 +2322,7 @@ gda_connection_delete_row_from_table (GdaConnection *cnc, const gchar *table,
  *
  * This function helps to parse a SQL string which uses parameters and store them at @params.
  *
- * Returns: (transfer full) (allow-none): a #GdaStatement representing the SQL command, or %NULL if an error occurred
+ * Returns: (transfer full): a #GdaStatement representing the SQL command, or %NULL if an error occurred
  *
  * Since: 4.2.3
  */
@@ -2365,7 +2365,7 @@ gda_connection_parse_sql_string (GdaConnection *cnc, const gchar *sql, GdaSet **
  * for gda_connection_event_new() which improves performances by reusing as much as possible
  * #GdaConnectionEvent objects. Newly written database providers should use this method.
  *
- * Returns: (transfer full) (allow-none): a pointer to the next available connection event, or %NULL if event should
+ * Returns: (transfer full): a pointer to the next available connection event, or %NULL if event should
  * be ignored
  *
  * Since: 4.2
@@ -2562,7 +2562,7 @@ gda_connection_clear_events_list (GdaConnection *cnc)
  * to perform the type type of action. It is a wrapper around the gda_server_provider_create_operation()
  * method.
  *
- * Returns: (transfer full) (allow-none): a new #GdaServerOperation object, or %NULL in the connection's provider does not support the @type type
+ * Returns: (transfer full): a new #GdaServerOperation object, or %NULL in the connection's provider does not support the @type type
  * of operation or if an error occurred
  */
 GdaServerOperation*
@@ -2610,7 +2610,7 @@ gda_connection_perform_operation (GdaConnection *cnc, GdaServerOperation *op, GE
  * then %NULL is returned, and a general SQL parser can be obtained
  * using gda_sql_parser_new().
  *
- * Returns: (transfer full) (allow-none): a new #GdaSqlParser object, or %NULL
+ * Returns: (transfer full): a new #GdaSqlParser object, or %NULL
  */
 GdaSqlParser *
 gda_connection_create_parser (GdaConnection *cnc)
@@ -3111,7 +3111,7 @@ gda_connection_async_statement_execute (GdaConnection *cnc, GdaStatement *stmt,
  * would have if the statement had been
  * executed synchronously.
  *
- * Returns: (transfer full) (allow-none): a #GObject, or %NULL if an error occurred
+ * Returns: (transfer full): a #GObject, or %NULL if an error occurred
  *
  * Since: 4.2
  */
@@ -3320,7 +3320,7 @@ gda_connection_statement_execute_v (GdaConnection *cnc, GdaStatement *stmt, GdaS
  *
  * Execute a SQL SELECT command over an opened connection.
  *
- * Returns: (transfer full) (allow-none): a new #GdaDataModel if successful, %NULL otherwise
+ * Returns: (transfer full): a new #GdaDataModel if successful, %NULL otherwise
  *
  * Since: 4.2.3
  */
@@ -3450,7 +3450,7 @@ gda_connection_execute_non_select_command (GdaConnection *cnc, const gchar *sql,
  * Also see the <link linkend="limitations">provider's limitations</link>, and the
  * <link linkend="data-select">Advanced GdaDataSelect usage</link> sections.
  *
- * Returns: (transfer full) (allow-none): a #GObject, or %NULL if an error occurred 
+ * Returns: (transfer full): a #GObject, or %NULL if an error occurred 
  */
 GObject *
 gda_connection_statement_execute (GdaConnection *cnc, GdaStatement *stmt, GdaSet *params, 
@@ -3557,7 +3557,7 @@ gda_connection_statement_execute_non_select (GdaConnection *cnc, GdaStatement *s
  * See the documentation of the gda_connection_statement_execute() for information
  * about the @params list of parameters.
  *
- * Returns: (transfer full) (allow-none): a #GdaDataModel containing the data returned by the
+ * Returns: (transfer full): a #GdaDataModel containing the data returned by the
  * data source, or %NULL if an error occurred
  */
 GdaDataModel *
@@ -3604,7 +3604,7 @@ gda_connection_statement_execute_select (GdaConnection *cnc, GdaStatement *stmt,
  * See the documentation of the gda_connection_statement_execute() for information
  * about the @params list of parameters.
  *
- * Returns: (transfer full) (allow-none): a #GdaDataModel containing the data returned by the
+ * Returns: (transfer full): a #GdaDataModel containing the data returned by the
  * data source, or %NULL if an error occurred
  */
 GdaDataModel *
@@ -3702,7 +3702,7 @@ gda_connection_statement_execute_select_fullv (GdaConnection *cnc, GdaStatement
  * See the documentation of the gda_connection_statement_execute() for information
  * about the @params list of parameters.
  *
- * Returns: (transfer full) (allow-none): a #GdaDataModel containing the data returned by the
+ * Returns: (transfer full): a #GdaDataModel containing the data returned by the
  * data source, or %NULL if an error occurred
  */
 GdaDataModel *
@@ -5717,7 +5717,7 @@ gda_connection_internal_transaction_started (GdaConnection *cnc, const gchar *pa
 /**
  * gda_connection_internal_transaction_rolledback: (skip)
  * @cnc: a #GdaConnection
- * @trans_name: transaction's name, or %NULL
+ * @trans_name: (allow-none): transaction's name, or %NULL
  *
  * Internal functions to be called by database providers when a transaction has been rolled
  * back to keep track of the transaction status of the connection
@@ -5770,7 +5770,7 @@ gda_connection_internal_transaction_rolledback (GdaConnection *cnc, const gchar
 /**
  * gda_connection_internal_transaction_committed: (skip)
  * @cnc: a #GdaConnection
- * @trans_name: transaction's name, or %NULL
+ * @trans_name: (allow-none): transaction's name, or %NULL
  *
  * Internal functions to be called by database providers when a transaction has been committed
  * to keep track of the transaction status of the connection
@@ -5823,8 +5823,8 @@ gda_connection_internal_transaction_committed (GdaConnection *cnc, const gchar *
 /**
  * gda_connection_internal_savepoint_added: (skip)
  * @cnc: a #GdaConnection
- * @parent_trans: name of the parent transaction, or %NULL
- * @svp_name: savepoint's name, or %NULL
+ * @parent_trans: (allow-none): name of the parent transaction, or %NULL
+ * @svp_name: (allow-none): savepoint's name, or %NULL
  *
  * Internal functions to be called by database providers when a savepoint has been added
  * to keep track of the transaction status of the connection
@@ -5867,7 +5867,7 @@ gda_connection_internal_savepoint_added (GdaConnection *cnc, const gchar *parent
 /**
  * gda_connection_internal_savepoint_rolledback: (skip)
  * @cnc: a #GdaConnection
- * @svp_name: savepoint's name, or %NULL
+ * @svp_name: (allow-none): savepoint's name, or %NULL
  *
  * Internal functions to be called by database providers when a savepoint has been rolled back
  * to keep track of the transaction status of the connection
@@ -5911,7 +5911,7 @@ gda_connection_internal_savepoint_rolledback (GdaConnection *cnc, const gchar *s
 /**
  * gda_connection_internal_savepoint_removed: (skip)
  * @cnc: a #GdaConnection
- * @svp_name: savepoint's name, or %NULL
+ * @svp_name: (allow-none): savepoint's name, or %NULL
  *
  * Internal functions to be called by database providers when a savepoint has been removed
  * to keep track of the transaction status of the connection



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