[libgda] Added lots of annotations
- From: Vivien Malerba <vivien src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgda] Added lots of annotations
- Date: Fri, 8 Oct 2010 18:48:04 +0000 (UTC)
commit 1cab4bf735db3ddb0a3ae866775ee1f54f62f72b
Author: Jonh Wendell <jwendell gnome org>
Date: Thu Oct 7 17:45:17 2010 -0300
Added lots of annotations
libgda/gda-attributes-manager.c | 6 ++--
libgda/gda-batch.c | 4 +-
libgda/gda-column.c | 2 +-
libgda/gda-config.c | 4 +-
libgda/gda-connection.c | 53 +++++++++++++--------------
libgda/gda-data-access-wrapper.c | 2 +-
libgda/gda-data-model-array.c | 6 ++--
libgda/gda-data-model-dir.c | 2 +-
libgda/gda-data-model-import.c | 6 ++--
libgda/gda-data-proxy.c | 2 +-
libgda/gda-data-select.c | 4 +-
libgda/gda-easy.c | 14 ++++----
libgda/gda-holder.c | 4 +-
libgda/gda-meta-store.c | 6 ++--
libgda/gda-meta-struct.c | 6 ++--
libgda/gda-mutex.c | 2 +-
libgda/gda-quark-list.c | 6 ++--
libgda/gda-server-operation.c | 6 ++--
libgda/gda-server-operation.h | 2 +-
libgda/gda-server-provider-extra.c | 6 +++
libgda/gda-server-provider.c | 8 ++--
libgda/gda-sql-builder.c | 10 ++---
libgda/gda-sql-builder.h | 2 +-
libgda/gda-statement.c | 2 +-
libgda/gda-transaction-status.c | 23 +++++++++++-
libgda/gda-tree-manager.c | 8 ++--
libgda/gda-tree.c | 4 +-
libgda/gda-util.c | 8 ++--
libgda/gda-value.c | 17 ++++++++-
libgda/gda-xa-transaction.c | 4 +-
libgda/handlers/gda-handler-bin.c | 4 +-
libgda/handlers/gda-handler-boolean.c | 4 +-
libgda/handlers/gda-handler-numerical.c | 4 +-
libgda/handlers/gda-handler-string.c | 10 +++---
libgda/handlers/gda-handler-time.c | 8 ++--
libgda/handlers/gda-handler-type.c | 4 +-
libgda/providers-support/gda-pstmt.c | 2 +-
libgda/sql-parser/gda-sql-parser.c | 6 ++--
libgda/sql-parser/gda-statement-struct.c | 6 ++--
libgda/thread-wrapper/gda-thread-wrapper.c | 10 +++---
40 files changed, 163 insertions(+), 124 deletions(-)
---
diff --git a/libgda/gda-attributes-manager.c b/libgda/gda-attributes-manager.c
index a94b769..a591d66 100644
--- a/libgda/gda-attributes-manager.c
+++ b/libgda/gda-attributes-manager.c
@@ -91,7 +91,7 @@ objattrs_unref (ObjAttrs *attrs)
}
/**
- * gda_attributes_manager_new:
+ * gda_attributes_manager_new: (skip):
* @for_objects: set to TRUE if attributes will be set on objects.
* @signal_func: a function to be called whenever an attribute changes on an object (if @for_objects is TRUE), or %NULL
* @signal_data: user data passed as last argument of @signal_func when it is called
@@ -408,8 +408,8 @@ static void foreach_foreach_func (AttName *attname, const GValue *value, FData *
* gda_attributes_manager_foreach:
* @mgr: a #GdaAttributesManager
* @ptr: a pointer to the resources for which all the attributes used
- * @func: a #GdaAttributesManagerFunc function
- * @data: user data to be passed as last argument of @func each time it is called
+ * @func: (scope call): a #GdaAttributesManagerFunc function
+ * @data: (closure): user data to be passed as last argument of @func each time it is called
*
* Calls @func for every attribute set to @ptr.
*/
diff --git a/libgda/gda-batch.c b/libgda/gda-batch.c
index b92f320..86421ac 100644
--- a/libgda/gda-batch.c
+++ b/libgda/gda-batch.c
@@ -169,7 +169,7 @@ gda_batch_new (void)
*
* Copy constructor
*
- * Returns: a the new copy of @orig
+ * Returns: (transfer full): a the new copy of @orig
*/
GdaBatch *
gda_batch_copy (GdaBatch *orig)
@@ -387,7 +387,7 @@ gda_batch_get_statements (GdaBatch *batch)
/**
* gda_batch_get_parameters:
* @batch: a #GdaBatch object
- * @out_params: (out) (tranfer full) (allow-none): a place to store a new #GdaSet object, or %NULL
+ * @out_params: (out) (transfer full) (allow-none): a place to store a new #GdaSet object, or %NULL
* @error: a place to store errors, or %NULL
*
* Get a new #GdaSet object which groups all the execution parameters
diff --git a/libgda/gda-column.c b/libgda/gda-column.c
index fbebf62..2b9605c 100644
--- a/libgda/gda-column.c
+++ b/libgda/gda-column.c
@@ -268,7 +268,7 @@ gda_column_new (void)
*
* Creates a new #GdaColumn object from an existing one.
*
- * Returns: a newly allocated #GdaColumn with a copy of the data
+ * Returns: (transfer full): a newly allocated #GdaColumn with a copy of the data
* in @column.
*/
GdaColumn *
diff --git a/libgda/gda-config.c b/libgda/gda-config.c
index ed2524b..8db0ee0 100644
--- a/libgda/gda-config.c
+++ b/libgda/gda-config.c
@@ -1089,7 +1089,7 @@ gda_config_dsn_needs_authentication (const gchar *dsn_name)
* <listitem><para>Username if it exists</para></listitem>
* </itemizedlist>
*
- * Returns: a new #GdaDataModel
+ * Returns: (transfer full): a new #GdaDataModel
*/
GdaDataModel *
gda_config_list_dsn (void)
@@ -1311,7 +1311,7 @@ gda_config_get_provider (const gchar *provider_name, GError **error)
* <listitem><para>File name of the plugin</para></listitem>
* </itemizedlist>
*
- * Returns: a new #GdaDataModel
+ * Returns: (transfer full): a new #GdaDataModel
*/
GdaDataModel *
gda_config_list_providers (void)
diff --git a/libgda/gda-connection.c b/libgda/gda-connection.c
index 7b0ec34..7a5fbce 100644
--- a/libgda/gda-connection.c
+++ b/libgda/gda-connection.c
@@ -945,7 +945,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: a new #GdaConnection if connection opening was sucessfull or %NULL if there was an error.
+ * Returns: (transfer full) (allow-none): 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,
@@ -1099,7 +1099,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: a new #GdaConnection if connection opening was sucessfull or %NULL if there was an error.
+ * Returns: (transfer full) (allow-none): 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,
@@ -1264,8 +1264,7 @@ sqlite_connection_closed_cb (GdaConnection *cnc, G_GNUC_UNUSED gpointer data)
/**
* gda_connection_open_sqlite:
- * @cnc_string: a connection string
- * @directory: the directory the database file will be in, or %NULL for the default TMP directory
+ * @directory: (allow-none): the directory the database file will be in, or %NULL for the default TMP directory
* @filename: the database file name
* @auto_unlink: if %TRUE, then the database file will be removed afterwards
*
@@ -1273,7 +1272,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: a new #GdaConnection, or %NULL if an error occurred
+ * Returns: (transfer full) (allow-none): a new #GdaConnection, or %NULL if an error occurred
*/
GdaConnection *
gda_connection_open_sqlite (const gchar *directory, const gchar *filename, gboolean auto_unlink)
@@ -1739,7 +1738,7 @@ gda_connection_get_authentication (GdaConnection *cnc)
}
/**
- * gda_connection_point_available_event
+ * gda_connection_point_available_event:
* @cnc: a #GdaConnection object
* @type: a #GdaConnectionEventType
*
@@ -1748,7 +1747,7 @@ gda_connection_get_authentication (GdaConnection *cnc)
* 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): a pointer to the next available connection event, or %NULL if event should
+ * Returns: (transfer full) (allow-none): a pointer to the next available connection event, or %NULL if event should
* be ignored
*
* Since: 4.2
@@ -1945,7 +1944,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: a new #GdaServerOperation object, or %NULL in the connection's provider does not support the @type type
+ * Returns: (transfer full) (allow-none): 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*
@@ -1993,7 +1992,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: a new #GdaSqlParser object, or %NULL
+ * Returns: (transfer full) (allow-none): a new #GdaSqlParser object, or %NULL
*/
GdaSqlParser *
gda_connection_create_parser (GdaConnection *cnc)
@@ -2051,7 +2050,7 @@ change_events_array_max_size (GdaConnection *cnc, gint size)
* the list of #GObject created by the correct execution of the previous statements. If a transaction is required,
* then it should be started before calling this method.
*
- * Returns: (element-type GObject): a new list of #GObject objects
+ * Returns: (transfer full) (element-type GObject): a new list of #GObject objects
*/
GSList *
gda_connection_batch_execute (GdaConnection *cnc, GdaBatch *batch, GdaSet *params,
@@ -2446,7 +2445,7 @@ gda_connection_async_statement_execute (GdaConnection *cnc, GdaStatement *stmt,
* would have if the statement had been
* executed synchronously.
*
- * Returns: a #GObject, or %NULL if an error occurred
+ * Returns: (transfer full) (allow-none): a #GObject, or %NULL if an error occurred
*
* Since: 4.2
*/
@@ -2685,7 +2684,7 @@ gda_connection_statement_execute_v (GdaConnection *cnc, GdaStatement *stmt, GdaS
* Also see the <link linkend="limitations">provider's limitations</link>, and the
* <link linkend="data-select">Advanced GdaDataSelect usage</link> sections.
*
- * Returns: a #GObject, or %NULL if an error occurred
+ * Returns: (transfer full) (allow-none): a #GObject, or %NULL if an error occurred
*/
GObject *
gda_connection_statement_execute (GdaConnection *cnc, GdaStatement *stmt, GdaSet *params,
@@ -2793,7 +2792,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: a #GdaDataModel containing the data returned by the
+ * Returns: (transfer full) (allow-none): a #GdaDataModel containing the data returned by the
* data source, or %NULL if an error occurred
*/
GdaDataModel *
@@ -2840,7 +2839,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: a #GdaDataModel containing the data returned by the
+ * Returns: (transfer full) (allow-none): a #GdaDataModel containing the data returned by the
* data source, or %NULL if an error occurred
*/
GdaDataModel *
@@ -2918,7 +2917,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: a #GdaDataModel containing the data returned by the
+ * Returns: (transfer full) (allow-none): a #GdaDataModel containing the data returned by the
* data source, or %NULL if an error occurred
*/
GdaDataModel *
@@ -4648,7 +4647,7 @@ prepare_meta_statements_hash (void)
* meta data section about SQL identifiers</link> for more information, and the documentation about the
* gda_sql_identifier_quote() function which will be most useful.
*
- * Returns: a #GdaDataModel containing the data required. The caller is responsible
+ * Returns: (transfer full): a #GdaDataModel containing the data required. The caller is responsible
* for freeing the returned model using g_object_unref().
*/
GdaDataModel *
@@ -4701,7 +4700,7 @@ gda_connection_get_meta_store_data (GdaConnection *cnc,
*
* see #gda_connection_get_meta_store_data
*
- * Returns: a #GdaDataModel containing the data required. The caller is responsible
+ * Returns: (transfer full): a #GdaDataModel containing the data required. The caller is responsible
* for freeing the returned model using g_object_unref().
*/
GdaDataModel *
@@ -4842,8 +4841,8 @@ gda_connection_value_to_sql_string (GdaConnection *cnc, GValue *from)
/**
* gda_connection_internal_transaction_started: (skip)
* @cnc: a #GdaConnection
- * @parent_trans: (allow-null): name of the parent transaction, or %NULL
- * @trans_name: (allow-null): transaction's name, or %NULL
+ * @parent_trans: name of the parent transaction, or %NULL
+ * @trans_name: transaction's name, or %NULL
* @isol_level: isolation level.
*
* Internal functions to be called by database providers when a transaction has been started
@@ -4892,7 +4891,7 @@ gda_connection_internal_transaction_started (GdaConnection *cnc, const gchar *pa
/**
* gda_connection_internal_transaction_rolledback: (skip)
* @cnc: a #GdaConnection
- * @trans_name: (allow-null): transaction's name, or %NULL
+ * @trans_name: 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
@@ -4945,7 +4944,7 @@ gda_connection_internal_transaction_rolledback (GdaConnection *cnc, const gchar
/**
* gda_connection_internal_transaction_committed: (skip)
* @cnc: a #GdaConnection
- * @trans_name: (allow-null): transaction's name, or %NULL
+ * @trans_name: 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
@@ -4998,8 +4997,8 @@ gda_connection_internal_transaction_committed (GdaConnection *cnc, const gchar *
/**
* gda_connection_internal_savepoint_added: (skip)
* @cnc: a #GdaConnection
- * @parent_trans: (allow-null): name of the parent transaction, or %NULL
- * @svp_name: (allow-null): savepoint's name, or %NULL
+ * @parent_trans: name of the parent transaction, or %NULL
+ * @svp_name: 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
@@ -5042,7 +5041,7 @@ gda_connection_internal_savepoint_added (GdaConnection *cnc, const gchar *parent
/**
* gda_connection_internal_savepoint_rolledback: (skip)
* @cnc: a #GdaConnection
- * @svp_name: (allow-null): savepoint's name, or %NULL
+ * @svp_name: 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
@@ -5086,7 +5085,7 @@ gda_connection_internal_savepoint_rolledback (GdaConnection *cnc, const gchar *s
/**
* gda_connection_internal_savepoint_removed: (skip)
* @cnc: a #GdaConnection
- * @svp_name: (allow-null): savepoint's name, or %NULL
+ * @svp_name: 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
@@ -5131,7 +5130,7 @@ gda_connection_internal_savepoint_removed (GdaConnection *cnc, const gchar *svp_
* gda_connection_internal_statement_executed: (skip)
* @cnc: a #GdaConnection
* @stmt: a #GdaStatement which has been executed
- * @params: (allow-null): execution's parameters
+ * @params: execution's parameters
* @error: a #GdaConnectionEvent if the execution failed, or %NULL
*
* Internal functions to be called by database providers when a statement has been executed
@@ -5434,7 +5433,7 @@ gda_connection_internal_get_provider_data (GdaConnection *cnc)
*
* Get or initializes the #GdaMetaStore associated to @cnc
*
- * Returns: a #GdaMetaStore object
+ * Returns: (transfer full): a #GdaMetaStore object
*/
GdaMetaStore *
gda_connection_get_meta_store (GdaConnection *cnc)
diff --git a/libgda/gda-data-access-wrapper.c b/libgda/gda-data-access-wrapper.c
index 6a0fac7..d1ef79f 100644
--- a/libgda/gda-data-access-wrapper.c
+++ b/libgda/gda-data-access-wrapper.c
@@ -358,7 +358,7 @@ gda_data_access_wrapper_get_property (GObject *object,
* Creates a new #GdaDataModel object which buffers the rows of @model. This object is useful
* only if @model can only be accessed using cursor based method.
*
- * Returns: a pointer to the newly created #GdaDataModel.
+ * Returns: (transfer full): a pointer to the newly created #GdaDataModel.
*/
GdaDataModel *
gda_data_access_wrapper_new (GdaDataModel *model)
diff --git a/libgda/gda-data-model-array.c b/libgda/gda-data-model-array.c
index d659e7b..4cc00ea 100644
--- a/libgda/gda-data-model-array.c
+++ b/libgda/gda-data-model-array.c
@@ -271,7 +271,7 @@ gda_data_model_array_get_property (GObject *object, guint prop_id, GValue *value
* Creates a new #GdaDataModel object without initializing the column
* types. Using gda_data_model_array_new_with_g_types() is usually better.
*
- * Returns: a pointer to the newly created #GdaDataModel.
+ * Returns: (transfer full): a pointer to the newly created #GdaDataModel.
*/
GdaDataModel *
gda_data_model_array_new (gint cols)
@@ -290,7 +290,7 @@ gda_data_model_array_new (gint cols)
* Creates a new #GdaDataModel object with the column types as
* specified.
*
- * Returns: a pointer to the newly created #GdaDataModel.
+ * Returns: (transfer full): a pointer to the newly created #GdaDataModel.
*/
GdaDataModel *
gda_data_model_array_new_with_g_types (gint cols, ...)
@@ -323,7 +323,7 @@ gda_data_model_array_new_with_g_types (gint cols, ...)
*
* Makes a copy of @src into a new #GdaDataModelArray object
*
- * Returns: a new data model, or %NULL if an error occurred
+ * Returns: (transfer full) (allow-none): a new data model, or %NULL if an error occurred
*/
GdaDataModelArray *
gda_data_model_array_copy_model (GdaDataModel *src, GError **error)
diff --git a/libgda/gda-data-model-dir.c b/libgda/gda-data-model-dir.c
index 1687e11..0015fc6 100644
--- a/libgda/gda-data-model-dir.c
+++ b/libgda/gda-data-model-dir.c
@@ -660,7 +660,7 @@ gda_data_model_dir_get_property (GObject *object,
*
* Creates a new #GdaDataModel object to list all the files starting from @basedir
*
- * Returns: a new #GdaDataModel
+ * Returns: (transfer full): a new #GdaDataModel
*/
GdaDataModel *
gda_data_model_dir_new (const gchar *basedir)
diff --git a/libgda/gda-data-model-import.c b/libgda/gda-data-model-import.c
index 1105be2..004d527 100644
--- a/libgda/gda-data-model-import.c
+++ b/libgda/gda-data-model-import.c
@@ -689,7 +689,7 @@ gda_data_model_import_get_property (GObject *object,
* <listitem><para>Other formats: no option</para></listitem>
* </itemizedlist>
*
- * Returns: a pointer to the newly created #GdaDataModel.
+ * Returns: (transfer full): a pointer to the newly created #GdaDataModel.
*/
GdaDataModel *
gda_data_model_import_new_file (const gchar *filename, gboolean random_access, GdaSet *options)
@@ -717,7 +717,7 @@ gda_data_model_import_new_file (const gchar *filename, gboolean random_access,
* Important note: the @data string is not copied for memory efficiency reasons and should not
* therefore be altered in any way as long as the returned data model exists.
*
- * Returns: a pointer to the newly created #GdaDataModel.
+ * Returns: (transfer full): a pointer to the newly created #GdaDataModel.
*/
GdaDataModel *
gda_data_model_import_new_mem (const gchar *data, gboolean random_access, GdaSet *options)
@@ -739,7 +739,7 @@ gda_data_model_import_new_mem (const gchar *data, gboolean random_access, GdaSet
* Creates a new #GdaDataModel and loads the data in @node. The resulting data model
* can be accessed in a random way.
*
- * Returns: a pointer to the newly created #GdaDataModel.
+ * Returns: (transfer full): a pointer to the newly created #GdaDataModel.
*/
GdaDataModel *
gda_data_model_import_new_xml_node (xmlNodePtr node)
diff --git a/libgda/gda-data-proxy.c b/libgda/gda-data-proxy.c
index 40168cb..8849b0e 100644
--- a/libgda/gda-data-proxy.c
+++ b/libgda/gda-data-proxy.c
@@ -759,7 +759,7 @@ static void proxied_model_reset_cb (GdaDataModel *model, GdaDataProxy *proxy);
*
* Creates a new proxy for @model
*
- * Returns: a new #GdaDataProxy object
+ * Returns: (transfer full): a new #GdaDataProxy object
*/
GObject *
gda_data_proxy_new (GdaDataModel *model)
diff --git a/libgda/gda-data-select.c b/libgda/gda-data-select.c
index 32d2457..193c10d 100644
--- a/libgda/gda-data-select.c
+++ b/libgda/gda-data-select.c
@@ -788,7 +788,7 @@ gda_data_select_take_row (GdaDataSelect *model, GdaRow *row, gint rownum)
*
* Get the #GdaRow object stored within @model at row @rownum (without taking care of removed rows)
*
- * Returns: (tranfer none): the requested #GdaRow, or %NULL if not found
+ * Returns: (transfer none): the requested #GdaRow, or %NULL if not found
*/
GdaRow *
gda_data_select_get_stored_row (GdaDataSelect *model, gint rownum)
@@ -811,7 +811,7 @@ gda_data_select_get_stored_row (GdaDataSelect *model, gint rownum)
* Get a pointer to the #GdaConnection object which was used when @model was created
* (and which may be used internally by @model).
*
- * Returns: (tranfer none): a pointer to the #GdaConnection, or %NULL
+ * Returns: (transfer none): a pointer to the #GdaConnection, or %NULL
*/
GdaConnection *
gda_data_select_get_connection (GdaDataSelect *model)
diff --git a/libgda/gda-easy.c b/libgda/gda-easy.c
index eb82717..f310286 100644
--- a/libgda/gda-easy.c
+++ b/libgda/gda-easy.c
@@ -52,7 +52,7 @@ GQuark gda_easy_error_quark (void)
* If @db_name is left %NULL, then the name of the database to create will have to be set in the
* returned #GdaServerOperation using gda_server_operation_set_value_at().
*
- * Returns: new #GdaServerOperation object, or %NULL if the provider does not support database
+ * Returns: (transfer full) (allow-none): new #GdaServerOperation object, or %NULL if the provider does not support database
* creation
*/
GdaServerOperation *
@@ -121,7 +121,7 @@ gda_perform_create_database (const gchar *provider, GdaServerOperation *op, GErr
* If @db_name is left %NULL, then the name of the database to drop will have to be set in the
* returned #GdaServerOperation using gda_server_operation_set_value_at().
*
- * Returns: new #GdaServerOperation object, or %NULL if the provider does not support database
+ * Returns: (transfer full) (allow-none): new #GdaServerOperation object, or %NULL if the provider does not support database
* destruction
*/
GdaServerOperation *
@@ -185,7 +185,7 @@ gda_perform_drop_database (const gchar *provider, GdaServerOperation *op, GError
*
* Execute a SQL SELECT command over an opened connection.
*
- * Returns: a new #GdaDataModel if successful, NULL otherwise
+ * Returns: (transfer full) (allow-none): a new #GdaDataModel if successful, NULL otherwise
*/
GdaDataModel *
gda_execute_select_command (GdaConnection *cnc, const gchar *sql, GError **error)
@@ -278,7 +278,7 @@ gda_execute_non_select_command (GdaConnection *cnc, const gchar *sql, GError **e
* or #gda_server_operation_perform_operation
* in order to execute the operation.
*
- * Returns: a #GdaServerOperation if no errors; NULL and set @error otherwise
+ * Returns: (transfer full) (allow-none): a #GdaServerOperation if no errors; NULL and set @error otherwise
*/
GdaServerOperation*
gda_prepare_create_table (GdaConnection *cnc, const gchar *table_name, GError **error, ...)
@@ -469,7 +469,7 @@ gda_perform_create_table (GdaServerOperation *op, GError **error)
* This is just a convenient function to create a #GdaServerOperation to drop a
* table in an opened connection.
*
- * Returns: a new #GdaServerOperation or NULL if couldn't create the opereration.
+ * Returns: (transfer full) (allow-none): a new #GdaServerOperation or NULL if couldn't create the opereration.
*/
GdaServerOperation*
gda_prepare_drop_table (GdaConnection *cnc, const gchar *table_name, GError **error)
@@ -1051,7 +1051,7 @@ gda_delete_row_from_table (GdaConnection *cnc, const gchar *table,
}
/**
- * gda_parse_sql_string
+ * gda_parse_sql_string:
* @cnc: (allow-none): a #GdaConnection object, or %NULL
* @sql: an SQL command to parse, not %NULL
* @params: (out) (allow-none) (transfer full): a place to store a new #GdaSet, for parameters used in SQL command, or %NULL
@@ -1059,7 +1059,7 @@ gda_delete_row_from_table (GdaConnection *cnc, const gchar *table,
*
* This function helps to parse a SQL witch use paramenters and store them at @params.
*
- * Returns: a #GdaStatement representing the SQL command, or %NULL if an error occurred
+ * Returns: (transfer full) (allow-none): a #GdaStatement representing the SQL command, or %NULL if an error occurred
*
* Since: 4.2
*/
diff --git a/libgda/gda-holder.c b/libgda/gda-holder.c
index d089163..dc1c17e 100644
--- a/libgda/gda-holder.c
+++ b/libgda/gda-holder.c
@@ -343,7 +343,7 @@ gda_holder_new (GType type)
* Note1: if @orig is set with a static value (see gda_holder_take_static_value())
* its copy will have a fresh new allocated GValue, so that user should free it when done.
*
- * Returns: a new #GdaHolder object
+ * Returns: (transfer full): a new #GdaHolder object
*/
GdaHolder *
gda_holder_copy (GdaHolder *orig)
@@ -677,7 +677,7 @@ gda_holder_get_property (GObject *object,
*
* Get @holder's type
*
- * Returns: (tranfer none): the data type
+ * Returns: (transfer none): the data type
*/
GType
gda_holder_get_g_type (GdaHolder *holder)
diff --git a/libgda/gda-meta-store.c b/libgda/gda-meta-store.c
index 1cea7e5..0990902 100644
--- a/libgda/gda-meta-store.c
+++ b/libgda/gda-meta-store.c
@@ -830,7 +830,7 @@ gda_meta_store_set_identifiers_style (GdaMetaStore *store, GdaSqlIdentifierStyle
/**
* gda_meta_store_set_reserved_keywords_func:
* @store: a #GdaMetaStore object
- * @func: (allow-none): a #GdaSqlReservedKeywordsFunc function, or %NULL
+ * @func: (allow-none) (scope call): a #GdaSqlReservedKeywordsFunc function, or %NULL
*
* Specifies a function which @store will use to determine if a keyword is an SQL reserved
* keyword or not.
@@ -3241,7 +3241,7 @@ gda_meta_store_create_modify_data_model (GdaMetaStore *store, const gchar *table
* are respected: if table B has a foreign key on table A, then table A will be listed before table B in the returned
* list.
*
- * Returns: (transfer container) (element type gchar*): a new list of tables names (as gchar*), the list must be freed when no longer needed, but the strings present in the list must not be modified.
+ * Returns: (transfer container) (element-type utf8): a new list of tables names (as gchar*), the list must be freed when no longer needed, but the strings present in the list must not be modified.
*/
GSList *
gda_meta_store_schema_get_all_tables (GdaMetaStore *store)
@@ -3281,7 +3281,7 @@ gda_meta_store_schema_get_all_tables (GdaMetaStore *store)
* are respected: if table B has a foreign key on table A, then table A will be listed before table B in the returned
* list.
*
- * Returns: (transfer container) (element type gchar*): a new list of tables names (as gchar*), the list must be freed when no longer needed, but the strings present in the list must not be modified.
+ * Returns: (transfer container) (element-type utf8): a new list of tables names (as gchar*), the list must be freed when no longer needed, but the strings present in the list must not be modified.
*/
GSList *
gda_meta_store_schema_get_depend_tables (GdaMetaStore *store, const gchar *table_name)
diff --git a/libgda/gda-meta-struct.c b/libgda/gda-meta-struct.c
index 5081c51..35ec743 100644
--- a/libgda/gda-meta-struct.c
+++ b/libgda/gda-meta-struct.c
@@ -1608,7 +1608,7 @@ gda_meta_struct_get_db_object (GdaMetaStruct *mstruct, const GValue *catalog, co
}
/**
- * gda_meta_struct_get_table_column
+ * gda_meta_struct_get_table_column: (skip):
* @mstruct: a #GdaMetaStruct object
* @table: the #GdaMetaTable structure to find the column for
* @col_name: the name of the column to find (as a G_TYPE_STRING GValue)
@@ -2342,8 +2342,8 @@ gda_meta_table_column_set_attribute (GdaMetaTableColumn *tcol, const gchar *attr
/**
* gda_meta_table_column_foreach_attribute:
* @tcol: a #GdaMetaTableColumn
- * @func: a #GdaAttributesManagerFunc function
- * @data: user data to be passed as last argument of @func each time it is called
+ * @func: (scope call): a #GdaAttributesManagerFunc function
+ * @data: (closure): user data to be passed as last argument of @func each time it is called
*
* Calls @func for each attribute set to tcol
*/
diff --git a/libgda/gda-mutex.c b/libgda/gda-mutex.c
index 37e31ba..09823d8 100644
--- a/libgda/gda-mutex.c
+++ b/libgda/gda-mutex.c
@@ -36,7 +36,7 @@ struct _GdaMutex {
};
/**
- * gda_mutex_new:
+ * gda_mutex_new: (skip):
*
* Creates a new #GdaMutex.
*
diff --git a/libgda/gda-quark-list.c b/libgda/gda-quark-list.c
index afcade3..fae89be 100644
--- a/libgda/gda-quark-list.c
+++ b/libgda/gda-quark-list.c
@@ -252,10 +252,10 @@ gda_quark_list_remove (GdaQuarkList *qlist, const gchar *name)
}
/**
- * gda_quark_list_foreach
+ * gda_quark_list_foreach:
* @qlist: a #GdaQuarkList structure.
- * @func: the function to call for each key/value pair
- * @user_data: user data to pass to the function
+ * @func: (scope call): the function to call for each key/value pair
+ * @user_data: (closure): user data to pass to the function
*
* Calls the given function for each of the key/value pairs in @qlist. The function is passed the key and value
* of each pair, and the given user_data parameter. @qlist may not be modified while iterating over it.
diff --git a/libgda/gda-server-operation.c b/libgda/gda-server-operation.c
index 830148e..560a6ee 100644
--- a/libgda/gda-server-operation.c
+++ b/libgda/gda-server-operation.c
@@ -1052,7 +1052,7 @@ gda_server_operation_new (GdaServerOperationType op_type, const gchar *xml_file)
}
/**
- * gda_server_operation_get_node_info:
+ * gda_server_operation_get_node_info: (skip):
* @op: a #GdaServerOperation object
* @path_format: a complete path to a node (starting with "/") as a format string, similar to g_strdup_printf()'s argument
* @...: the arguments to insert into the format string
@@ -1060,7 +1060,7 @@ gda_server_operation_new (GdaServerOperationType op_type, const gchar *xml_file)
* Get information about the node identified by @path. The returned #GdaServerOperationNode structure can be
* copied but not modified; it may change or cease to exist if @op changes
*
- * Returns: (transfer none): a #GdaServerOperationNode structure, or %NULL if the node was not found
+ * Returns: (transfer none) (allow-none): a #GdaServerOperationNode structure, or %NULL if the node was not found
*/
GdaServerOperationNode *
gda_server_operation_get_node_info (GdaServerOperation *op, const gchar *path_format, ...)
@@ -1293,7 +1293,7 @@ gda_server_operation_string_to_op_type (const gchar *str)
static gboolean node_save (GdaServerOperation *op, Node *opnode, xmlNodePtr parent);
/**
- * gda_server_operation_save_data_to_xml:
+ * gda_server_operation_save_data_to_xml: (skip):
* @op: a #GdaServerOperation object
* @error: (allow-none): a place to store errors or %NULL
*
diff --git a/libgda/gda-server-operation.h b/libgda/gda-server-operation.h
index 42ce83f..eb39d1d 100644
--- a/libgda/gda-server-operation.h
+++ b/libgda/gda-server-operation.h
@@ -143,7 +143,7 @@ guint gda_server_operation_get_sequence_max_size (GdaServ
guint gda_server_operation_get_sequence_min_size (GdaServerOperation *op, const gchar *path);
gchar **gda_server_operation_get_sequence_item_names (GdaServerOperation *op, const gchar *path);
-guint gda_server_operation_add_item_to_sequence (GdaServerOperation *op, const gchar *path);
+guint gda_server_operation_add_item_to_sequence (GdaServerOperation *op, const gchar *seq_path);
gboolean gda_server_operation_del_item_from_sequence (GdaServerOperation *op, const gchar *item_path);
gboolean gda_server_operation_is_valid (GdaServerOperation *op, const gchar *xml_file, GError **error);
diff --git a/libgda/gda-server-provider-extra.c b/libgda/gda-server-provider-extra.c
index afafa28..765fdc7 100644
--- a/libgda/gda-server-provider-extra.c
+++ b/libgda/gda-server-provider-extra.c
@@ -566,6 +566,12 @@ gda_server_provider_test_schema_model (GdaDataModel *model, GdaConnectionSchema
return TRUE;
}
+/**
+ * gda_server_provider_handler_find:
+ *
+ * Returns: (transfer none):
+ *
+ */
GdaDataHandler *
gda_server_provider_handler_find (GdaServerProvider *prov, GdaConnection *cnc,
GType g_type, const gchar *dbms_type)
diff --git a/libgda/gda-server-provider.c b/libgda/gda-server-provider.c
index 20ff1e1..7c08c43 100644
--- a/libgda/gda-server-provider.c
+++ b/libgda/gda-server-provider.c
@@ -452,7 +452,7 @@ static OpReq op_req_CREATE_USER [] = {
* <listitem>named values which may change the contents of the GdaServerOperation, see <link linkend="gda-server-op-information-std">this section</link> for more information</listitem>
* </itemizedlist>
*
- * Returns: (transfer full): a new #GdaServerOperation object, or %NULL in the provider does not support the @type type of operation or if an error occurred
+ * Returns: (transfer full) (allow-none): a new #GdaServerOperation object, or %NULL in the provider does not support the @type type of operation or if an error occurred
*/
GdaServerOperation *
gda_server_provider_create_operation (GdaServerProvider *provider, GdaConnection *cnc,
@@ -560,7 +560,7 @@ gda_server_provider_create_operation (GdaServerProvider *provider, GdaConnection
* This function's purpose is mainly informative to get the actual SQL code which would be executed to perform
* the operation; to actually perform the operation, use gda_server_provider_perform_operation().
*
- * Returns: (transfer full): a new string, or %NULL if an error occurred or operation cannot be rendered as SQL.
+ * Returns: (transfer full) (allow-none): a new string, or %NULL if an error occurred or operation cannot be rendered as SQL.
*/
gchar *
gda_server_provider_render_operation (GdaServerProvider *provider, GdaConnection *cnc,
@@ -735,7 +735,7 @@ gda_server_provider_get_data_handler_dbms (GdaServerProvider *provider, GdaConne
/**
* gda_server_provider_get_default_dbms_type:
* @provider: a server provider.
- * @cnc:(allow-none): a #GdaConnection object or %NULL
+ * @cnc: (allow-none): a #GdaConnection object or %NULL
* @type: a #GType value type
*
* Get the name of the most common data type which has @type type.
@@ -744,7 +744,7 @@ gda_server_provider_get_data_handler_dbms (GdaServerProvider *provider, GdaConne
* there is no DBMS data type which could contain data of the @g_type type (for example %NULL may be
* returned if a DBMS has integers only up to 4 bytes and a G_TYPE_INT64 is requested).
*
- * Returns: (transfer none): the name of the DBMS type, or %NULL
+ * Returns: (transfer none) (allow-none): the name of the DBMS type, or %NULL
*/
const gchar *
gda_server_provider_get_default_dbms_type (GdaServerProvider *provider, GdaConnection *cnc, GType type)
diff --git a/libgda/gda-sql-builder.c b/libgda/gda-sql-builder.c
index 1494058..06de52e 100644
--- a/libgda/gda-sql-builder.c
+++ b/libgda/gda-sql-builder.c
@@ -344,14 +344,13 @@ gda_sql_builder_get_statement (GdaSqlBuilder *builder, GError **error)
/**
* gda_sql_builder_get_sql_statement:
* @builder: a #GdaSqlBuilder object
- * @copy_it: set to %TRUE to be able to reuse @builder
*
* Creates a new #GdaSqlStatement structure from @builder's contents.
*
* The returned pointer belongs to @builder's internal representation.
* Use gda_sql_statement_copy() if you need to keep it.
*
- * Returns: (transfer none): a #GdaSqlStatement pointer
+ * Returns: (transfer none) (allow-none): a #GdaSqlStatement pointer
*
* Since: 4.2
*/
@@ -948,7 +947,7 @@ gda_sql_builder_add_id (GdaSqlBuilder *builder, const gchar *string)
* gda_sql_builder_add_field_id:
* @builder: a #GdaSqlBuilder object
* @field_name: a field name
- * @table_name: (allow-null): a table name, or %NULL
+ * @table_name: (allow-none): a table name, or %NULL
*
* Defines an expression representing a field in @builder,
* which may be reused to build other parts of a statement,
@@ -1622,7 +1621,7 @@ gda_sql_builder_select_group_by (GdaSqlBuilder *builder, GdaSqlBuilderId expr_id
/**
* gda_sql_builder_add_function:
* @builder: a #GdaSqlBuilder object
- * @function_id: the ID of the functions's name
+ * @func_name: the functions's name
* @...: a list, terminated with %0, of each function's argument's ID
*
* Builds a new expression which reprenents a function applied to some arguments
@@ -1667,7 +1666,7 @@ gda_sql_builder_add_function (GdaSqlBuilder *builder, const gchar *func_name, ..
/**
* gda_sql_builder_add_function_v:
* @builder: a #GdaSqlBuilder object
- * @function_id: the ID of the functions's name
+ * @func_name: the functions's name
* @args: (array length=args_size): an array of IDs representing the function's arguments
* @args_size: @args's size
*
@@ -1711,7 +1710,6 @@ gda_sql_builder_add_function_v (GdaSqlBuilder *builder, const gchar *func_name,
* gda_sql_builder_add_sub_select:
* @builder: a #GdaSqlBuilder object
* @sqlst: a pointer to a #GdaSqlStatement, which has to be a SELECT or compound SELECT. This will be copied.
- * @steal: if %TRUE, then @sqlst will be "stolen" by @b and should not be used anymore
*
* Adds an expression which is a subselect.
*
diff --git a/libgda/gda-sql-builder.h b/libgda/gda-sql-builder.h
index 8c07794..90d6eb3 100644
--- a/libgda/gda-sql-builder.h
+++ b/libgda/gda-sql-builder.h
@@ -117,7 +117,7 @@ void gda_sql_builder_select_order_by (GdaSqlBuilder *builder, GdaSq
void gda_sql_builder_select_set_distinct (GdaSqlBuilder *builder,
gboolean distinct, GdaSqlBuilderId expr_id);
void gda_sql_builder_select_set_limit (GdaSqlBuilder *builder,
- GdaSqlBuilderId limit_count_expr_id, GdaSqlBuilderId limit_offest_expr_id);
+ GdaSqlBuilderId limit_count_expr_id, GdaSqlBuilderId limit_offset_expr_id);
void gda_sql_builder_select_set_having (GdaSqlBuilder *builder, GdaSqlBuilderId cond_id);
void gda_sql_builder_select_group_by (GdaSqlBuilder *builder, GdaSqlBuilderId expr_id);
diff --git a/libgda/gda-statement.c b/libgda/gda-statement.c
index d562f4c..a96b432 100644
--- a/libgda/gda-statement.c
+++ b/libgda/gda-statement.c
@@ -205,7 +205,7 @@ _gda_statement_get_internal_struct (GdaStatement *stmt)
*
* Copy constructor
*
- * Returns: a the new copy of @orig
+ * Returns: (transfer full): a the new copy of @orig
*/
GdaStatement *
gda_statement_copy (GdaStatement *orig)
diff --git a/libgda/gda-transaction-status.c b/libgda/gda-transaction-status.c
index 29d2369..4aad698 100644
--- a/libgda/gda-transaction-status.c
+++ b/libgda/gda-transaction-status.c
@@ -151,6 +151,10 @@ gda_transaction_status_new (const gchar *name)
return tstatus;
}
+/**
+ * gda_transaction_status_add_event_svp: (skip):
+ *
+ */
GdaTransactionStatusEvent *
gda_transaction_status_add_event_svp (GdaTransactionStatus *tstatus, const gchar *svp_name)
{
@@ -168,6 +172,10 @@ gda_transaction_status_add_event_svp (GdaTransactionStatus *tstatus, const gchar
return ev;
}
+/**
+ * gda_transaction_status_add_event_sql: (skip):
+ *
+ */
GdaTransactionStatusEvent *
gda_transaction_status_add_event_sql (GdaTransactionStatus *tstatus, const gchar *sql, GdaConnectionEvent *conn_event)
{
@@ -189,6 +197,10 @@ gda_transaction_status_add_event_sql (GdaTransactionStatus *tstatus, const gchar
return ev;
}
+/**
+ * gda_transaction_status_add_event_sub: (skip)
+ *
+ */
GdaTransactionStatusEvent *
gda_transaction_status_add_event_sub (GdaTransactionStatus *tstatus, GdaTransactionStatus *sub_trans)
{
@@ -231,6 +243,11 @@ gda_transaction_status_free_events (GdaTransactionStatus *tstatus, GdaTransactio
tstatus->events = g_list_delete_link (tstatus->events, node);
}
+/**
+ * gda_transaction_status_find:
+ *
+ * Returns: (transfer full) (allow-none):
+ */
GdaTransactionStatus *
gda_transaction_status_find (GdaTransactionStatus *tstatus, const gchar *str, GdaTransactionStatusEvent **destev)
{
@@ -274,9 +291,13 @@ gda_transaction_status_find (GdaTransactionStatus *tstatus, const gchar *str, Gd
return trans;
}
-/*
+/**
+ * gda_transaction_status_find_current:
+ *
* Find a pointer to the "current" _unnamed_ transaction, which is the last
* transaction if there are several nested transactions
+ *
+ * Returns: (transfer full) (allow-none):
*/
GdaTransactionStatus *
gda_transaction_status_find_current (GdaTransactionStatus *tstatus, GdaTransactionStatusEvent **destev, gboolean unnamed_only)
diff --git a/libgda/gda-tree-manager.c b/libgda/gda-tree-manager.c
index 4b391cd..640b301 100644
--- a/libgda/gda-tree-manager.c
+++ b/libgda/gda-tree-manager.c
@@ -303,7 +303,7 @@ _gda_tree_manager_update_children (GdaTreeManager *manager, GdaTreeNode *node, c
/**
* gda_tree_manager_new_with_func:
- * @update_func: the function to call when the manager object is requested to create or update its list of
+ * @update_func: (scope call): the function to call when the manager object is requested to create or update its list of
* #GdaTreeNode nodes
*
* Use this method to create a new #GdaTreeManager if it's more convenient than subclassing; all is needed
@@ -439,7 +439,7 @@ gda_tree_manager_get_managers (GdaTreeManager *manager)
/**
* gda_tree_manager_set_node_create_func:
* @manager: a #GdaTreeManager tree manager object
- * @func: (allow-none): a #GdaTreeManagerNodeFunc function pointer, or %NULL
+ * @func: (allow-none) (scope call): a #GdaTreeManagerNodeFunc function pointer, or %NULL
*
* Sets the function to be called when a new node is being created by @manager. If @func is %NULL
* then each created node will be a #GdaTreeNode object.
@@ -457,12 +457,12 @@ gda_tree_manager_set_node_create_func (GdaTreeManager *manager, GdaTreeManagerNo
}
/**
- * gda_tree_manager_get_node_create_func:
+ * gda_tree_manager_get_node_create_func: (skip):
* @manager: a #GdaTreeManager tree manager object
*
* Get the function used by @manager when creating new #GdaTreeNode nodes
*
- * Returns: (transfer none): the #GdaTreeManagerNodeFunc function, or %NULL if the default function is used
+ * Returns: the #GdaTreeManagerNodeFunc function, or %NULL if the default function is used
*
* Since: 4.2
*/
diff --git a/libgda/gda-tree.c b/libgda/gda-tree.c
index 7952303..9234450 100644
--- a/libgda/gda-tree.c
+++ b/libgda/gda-tree.c
@@ -637,7 +637,7 @@ build_node_path (GdaTree *tree, GdaTreeNode *node, GArray *array)
}
/**
- * gda_tree_get_node
+ * gda_tree_get_node:
* @tree: a #GdaTree object
* @tree_path: full path to the required nodes (if @use_names is %TRUE, then it must start with '/')
* @use_names: if %TRUE, then @tree_path will be interpreted as a unix style path, and if %FALSE,
@@ -645,7 +645,7 @@ build_node_path (GdaTree *tree, GdaTreeNode *node, GArray *array)
*
* Locates a #GdaTreeNode using the @tree_path path.
*
- * Returns: (transfer none): the requested #GdaTreeNode pointer, or %NULL if not found
+ * Returns: (transfer none) (allow-none): the requested #GdaTreeNode pointer, or %NULL if not found
*
* Since: 4.2
*/
diff --git a/libgda/gda-util.c b/libgda/gda-util.c
index 536dbd7..8235de2 100644
--- a/libgda/gda-util.c
+++ b/libgda/gda-util.c
@@ -1573,7 +1573,7 @@ cmp_func (gconstpointer a, gconstpointer b)
}
/**
- * gda_completion_list_get
+ * gda_completion_list_get:
* @cnc: a #GdaConnection object
* @sql: a partial SQL statement which is the context of the completion proposal
* @start: starting position within @sql of the "token" to complete (starts at 0)
@@ -1583,7 +1583,7 @@ cmp_func (gconstpointer a, gconstpointer b)
* If no completion is available, then the returned array contains just one NULL entry, and
* if it was not possible to try to compute a completions list, then %NULL is returned.
*
- * Returns: a new array of strings, or %NULL (use g_strfreev() to free the returned array)
+ * Returns: (transfer full) (array zero-terminated=1) (allow-none): a new array of strings, or %NULL (use g_strfreev() to free the returned array)
*/
gchar **
gda_completion_list_get (GdaConnection *cnc, const gchar *sql, gint start, gint end)
@@ -1836,7 +1836,7 @@ concat_ident (const char *prefix, const gchar *ident)
}
/**
- * gda_sql_identifier_split
+ * gda_sql_identifier_split:
* @id: an SQL identifier
*
* Splits @id into an array of it sub parts. @id's format has to be "<part>[.<part>[...]]" where
@@ -1845,7 +1845,7 @@ concat_ident (const char *prefix, const gchar *ident)
*
* For example the <![CDATA["test.\"ATable\""]]> string will result in the array: <![CDATA[{"test", "\"ATable\"", NULL}]]>
*
- * Returns: a new %NULL-terminated array of strings, or NULL (use g_strfreev() to free the returned array)
+ * Returns: (transfer full) (array zero-terminated=1) (allow-none): a new %NULL-terminated array of strings, or NULL (use g_strfreev() to free the returned array)
*/
gchar **
gda_sql_identifier_split (const gchar *id)
diff --git a/libgda/gda-value.c b/libgda/gda-value.c
index 89d6ade..116ed97 100644
--- a/libgda/gda-value.c
+++ b/libgda/gda-value.c
@@ -542,6 +542,11 @@ gda_geometricpoint_get_type (void)
return type;
}
+/**
+ * gda_geometricpoint_copy:
+ *
+ * Returns: (transfer full):
+ */
gpointer
gda_geometricpoint_copy (gpointer boxed)
{
@@ -926,6 +931,11 @@ gda_time_get_type(void)
return type;
}
+/**
+ * gda_time_copy:
+ *
+ * Returns: (transfer full):
+ */
gpointer
gda_time_copy (gpointer boxed)
{
@@ -1059,6 +1069,11 @@ gda_timestamp_get_type (void)
return type;
}
+/**
+ * gda_timestamp_copy:
+ *
+ * Returns: (transfer full):
+ */
gpointer
gda_timestamp_copy (gpointer boxed)
{
@@ -2425,7 +2440,7 @@ to_string (const GValue *value)
/**
- * gda_value_to_xml:
+ * gda_value_to_xml: (skip):
* @value: a #GValue.
*
* Serializes the given #GValue to an XML node string.
diff --git a/libgda/gda-xa-transaction.c b/libgda/gda-xa-transaction.c
index a62c60f..2d3705b 100644
--- a/libgda/gda-xa-transaction.c
+++ b/libgda/gda-xa-transaction.c
@@ -744,13 +744,13 @@ gda_xa_transaction_id_to_string (const GdaXaTransactionId *xid)
}
/**
- * gda_xa_transaction_string_to_id:
+ * gda_xa_transaction_string_to_id: (skip):
* @str: a string representation of a #GdaXaTransactionId, in the "gtrid,bqual,formatID" format
*
* Creates a new #GdaXaTransactionId structure from its string representation, it's the opposite
* of gda_xa_transaction_id_to_string().
*
- * Returns: (transfer full): a new #GdaXaTransactionId structure, or %NULL in @str has a wrong format
+ * Returns: a new #GdaXaTransactionId structure, or %NULL in @str has a wrong format
*
* Free-function: g_free
*/
diff --git a/libgda/handlers/gda-handler-bin.c b/libgda/handlers/gda-handler-bin.c
index 6c4ccf2..3ba2453 100644
--- a/libgda/handlers/gda-handler-bin.c
+++ b/libgda/handlers/gda-handler-bin.c
@@ -148,11 +148,11 @@ gda_handler_bin_dispose (GObject * object)
}
/**
- * gda_handler_bin_new
+ * gda_handler_bin_new:
*
* Creates a data handler for binary values
*
- * Returns: the new object
+ * Returns: (transfer full): the new object
*/
GdaDataHandler *
gda_handler_bin_new (void)
diff --git a/libgda/handlers/gda-handler-boolean.c b/libgda/handlers/gda-handler-boolean.c
index aecceda..9f3f87c 100644
--- a/libgda/handlers/gda-handler-boolean.c
+++ b/libgda/handlers/gda-handler-boolean.c
@@ -146,11 +146,11 @@ gda_handler_boolean_dispose (GObject *object)
}
/**
- * gda_handler_boolean_new
+ * gda_handler_boolean_new:
*
* Creates a data handler for booleans
*
- * Returns: the new object
+ * Returns: (transfer full): the new object
*/
GdaDataHandler *
gda_handler_boolean_new (void)
diff --git a/libgda/handlers/gda-handler-numerical.c b/libgda/handlers/gda-handler-numerical.c
index 065271e..2b30286 100644
--- a/libgda/handlers/gda-handler-numerical.c
+++ b/libgda/handlers/gda-handler-numerical.c
@@ -160,11 +160,11 @@ gda_handler_numerical_dispose (GObject *object)
}
/**
- * gda_handler_numerical_new
+ * gda_handler_numerical_new:
*
* Creates a data handler for numerical values
*
- * Returns: the new object
+ * Returns: (transfer full): the new object
*/
GdaDataHandler *
gda_handler_numerical_new (void)
diff --git a/libgda/handlers/gda-handler-string.c b/libgda/handlers/gda-handler-string.c
index bb330b0..ef3e583 100644
--- a/libgda/handlers/gda-handler-string.c
+++ b/libgda/handlers/gda-handler-string.c
@@ -156,11 +156,11 @@ gda_handler_string_dispose (GObject * object)
}
/**
- * gda_handler_string_new
+ * gda_handler_string_new:
*
* Creates a data handler for strings
*
- * Returns: the new object
+ * Returns: (transfer full): the new object
*/
GdaDataHandler *
gda_handler_string_new (void)
@@ -173,14 +173,14 @@ gda_handler_string_new (void)
}
/**
- * gda_handler_string_new_with_provider
+ * gda_handler_string_new_with_provider:
* @prov: a #GdaServerProvider object
- * @cnc: a #GdaConnection object, or %NULL
+ * @cnc: (allow-none): a #GdaConnection object, or %NULL
*
* Creates a data handler for strings, which will use some specific methods implemented
* by the @prov object (possibly also @cnc).
*
- * Returns: the new object
+ * Returns: (transfer full): the new object
*/
GdaDataHandler *
gda_handler_string_new_with_provider (GdaServerProvider *prov, GdaConnection *cnc)
diff --git a/libgda/handlers/gda-handler-time.c b/libgda/handlers/gda-handler-time.c
index 4f6fa7c..47eb371 100644
--- a/libgda/handlers/gda-handler-time.c
+++ b/libgda/handlers/gda-handler-time.c
@@ -195,11 +195,11 @@ gda_handler_time_dispose (GObject *object)
}
/**
- * gda_handler_time_new
+ * gda_handler_time_new:
*
* Creates a data handler for time values
*
- * Returns: the new object
+ * Returns: (transfer full): the new object
*/
GdaDataHandler *
gda_handler_time_new (void)
@@ -213,12 +213,12 @@ gda_handler_time_new (void)
}
/**
- * gda_handler_time_new_no_locale
+ * gda_handler_time_new_no_locale:
*
* Creates a data handler for time values, but using the default C locale
* instead of the current user locale.
*
- * Returns: the new object
+ * Returns: (transfer full): the new object
*/
GdaDataHandler *
gda_handler_time_new_no_locale (void)
diff --git a/libgda/handlers/gda-handler-type.c b/libgda/handlers/gda-handler-type.c
index f6a13e8..6be3885 100644
--- a/libgda/handlers/gda-handler-type.c
+++ b/libgda/handlers/gda-handler-type.c
@@ -145,11 +145,11 @@ gda_handler_type_dispose (GObject * object)
}
/**
- * gda_handler_type_new
+ * gda_handler_type_new:
*
* Creates a data handler for Gda types
*
- * Returns: the new object
+ * Returns: (transfer full): the new object
*/
GdaDataHandler *
gda_handler_type_new (void)
diff --git a/libgda/providers-support/gda-pstmt.c b/libgda/providers-support/gda-pstmt.c
index 17a977f..9f41046 100644
--- a/libgda/providers-support/gda-pstmt.c
+++ b/libgda/providers-support/gda-pstmt.c
@@ -213,7 +213,7 @@ gda_pstmt_copy_contents (GdaPStmt *src, GdaPStmt *dest)
}
/**
- * gda_pstmt_get_gda_statement
+ * gda_pstmt_get_gda_statement:
* @pstmt: a #GdaPStmt object
*
* Get a pointer to the #GdaStatement which led to the creation of this prepared statement.
diff --git a/libgda/sql-parser/gda-sql-parser.c b/libgda/sql-parser/gda-sql-parser.c
index 41679c0..36490b0 100644
--- a/libgda/sql-parser/gda-sql-parser.c
+++ b/libgda/sql-parser/gda-sql-parser.c
@@ -429,7 +429,7 @@ gda_sql_parser_get_property (GObject *object,
* To include variables in the @sql string, see the
* <link linkend="GdaSqlParser.description">GdaSqlParser's object description</link>.
*
- * Returns: a new #GdaStatement object, or %NULL if an error occurred
+ * Returns: (transfer full) (allow-none): a new #GdaStatement object, or %NULL if an error occurred
*/
GdaStatement *
gda_sql_parser_parse_string (GdaSqlParser *parser, const gchar *sql, const gchar **remain, GError **error)
@@ -666,7 +666,7 @@ gda_sql_parser_parse_string (GdaSqlParser *parser, const gchar *sql, const gchar
* To include variables in the @sql string, see the
* <link linkend="GdaSqlParser.description">GdaSqlParser's object description</link>.
*
- * Returns: a new #GdaBatch object, or %NULL if an error occurred
+ * Returns: (transfer full) (allow-none): a new #GdaBatch object, or %NULL if an error occurred
*/
GdaBatch *
gda_sql_parser_parse_string_as_batch (GdaSqlParser *parser, const gchar *sql, const gchar **remain,
@@ -752,7 +752,7 @@ gda_sql_parser_parse_string_as_batch (GdaSqlParser *parser, const gchar *sql, co
*
* if @sql is %NULL, then the returned #GdaBatch object will contain no statement.
*
- * Returns: a new #GdaBatch object, or %NULL if an error occurred
+ * Returns: (transfer full) (allow-none): a new #GdaBatch object, or %NULL if an error occurred
*/
GdaBatch *
gda_sql_parser_parse_file_as_batch (GdaSqlParser *parser, const gchar *filename, GError **error)
diff --git a/libgda/sql-parser/gda-statement-struct.c b/libgda/sql-parser/gda-statement-struct.c
index d4ef6d4..4b27b5f 100644
--- a/libgda/sql-parser/gda-statement-struct.c
+++ b/libgda/sql-parser/gda-statement-struct.c
@@ -1172,10 +1172,10 @@ gda_sql_any_part_check_structure (GdaSqlAnyPart *node, GError **error)
}
/**
- * gda_sql_any_part_foreach
+ * gda_sql_any_part_foreach:
* @node: the stat node
- * @func: function to call for each sub node
- * @data: data to pass to @func each time it is called
+ * @func: (scope call): function to call for each sub node
+ * @data: (closure): data to pass to @func each time it is called
* @error: a place to store errors, or %NULL (is also passed to @func)
*
* Calls a function for each element of a #GdaSqlAnyPart node
diff --git a/libgda/thread-wrapper/gda-thread-wrapper.c b/libgda/thread-wrapper/gda-thread-wrapper.c
index 8c87e07..c183e8a 100644
--- a/libgda/thread-wrapper/gda-thread-wrapper.c
+++ b/libgda/thread-wrapper/gda-thread-wrapper.c
@@ -777,7 +777,7 @@ gda_thread_wrapper_iterate (GdaThreadWrapper *wrapper, gboolean may_block)
}
/**
- * gda_thread_wrapper_fetch_result
+ * gda_thread_wrapper_fetch_result:
* @wrapper: a #GdaThreadWrapper object
* @may_lock: TRUE if this funct must lock the caller untill a result is available
* @exp_id: ID of the job for which a result is expected
@@ -786,7 +786,7 @@ gda_thread_wrapper_iterate (GdaThreadWrapper *wrapper, gboolean may_block)
* Use this method to check if the execution of a function is finished. The function's execution must have
* been requested using gda_thread_wrapper_execute().
*
- * Returns: the pointer returned by the execution, or %NULL if no result is available
+ * Returns: (transfer none) (allow-none): the pointer returned by the execution, or %NULL if no result is available
*
* Since: 4.2
*/
@@ -993,7 +993,7 @@ worker_thread_closure_marshal_anythread (GClosure *closure,
}
/**
- * gda_thread_wrapper_connect_raw
+ * gda_thread_wrapper_connect_raw:
* @wrapper: a #GdaThreadWrapper object
* @instance: the instance to connect to
* @sig_name: a string of the form "signal-name::detail"
@@ -1006,8 +1006,8 @@ worker_thread_closure_marshal_anythread (GClosure *closure,
* been emitted when a job created for the calling thread is being executed, and to %FALSE
* if @callback has to be called whenever the @sig_name signal is emitted by @instance. Note that
* this argument is not taken into account if @private_thread is set to %FALSE.
- * @callback: a #GdaThreadWrapperCallback function
- * @data: data to pass to @callback's calls
+ * @callback: (scope call): a #GdaThreadWrapperCallback function
+ * @data: (closure): data to pass to @callback's calls
*
* Connects a callback function to a signal for a particular object. The difference with g_signal_connect() and
* similar functions are:
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]