[libgda/LIBGDA_4.0] More GObject introspection annotations
- From: Vivien Malerba <vivien src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgda/LIBGDA_4.0] More GObject introspection annotations
- Date: Mon, 7 Jun 2010 17:18:03 +0000 (UTC)
commit 3f6e8e1b5b7fb6055236d7931aef48601fc76b8b
Author: Vivien Malerba <malerba gnome-db org>
Date: Mon Jun 7 18:35:24 2010 +0200
More GObject introspection annotations
libgda/gda-attributes-manager.c | 21 ++++----
libgda/gda-batch.c | 20 ++++----
libgda/gda-blob-op.c | 14 +++---
libgda/gda-column.c | 45 ++++++++--------
libgda/gda-config.c | 2 +-
libgda/gda-connection-event.c | 26 +++++-----
libgda/gda-data-access-wrapper.c | 6 +-
libgda/gda-data-comparator.c | 18 +++---
libgda/gda-data-model-array.c | 16 +++---
libgda/gda-data-model-bdb.c | 10 ++--
libgda/gda-data-model.c | 104 ++++++++++++++++++------------------
libgda/gda-set.c | 53 +++++++++---------
libgda/gda-statement.c | 32 ++++++------
libgda/sql-parser/gda-sql-parser.c | 14 +++---
14 files changed, 192 insertions(+), 189 deletions(-)
---
diff --git a/libgda/gda-attributes-manager.c b/libgda/gda-attributes-manager.c
index a801030..74f1007 100644
--- a/libgda/gda-attributes-manager.c
+++ b/libgda/gda-attributes-manager.c
@@ -1,6 +1,6 @@
/*
* GDA common library
- * Copyright (C) 2008 The GNOME Foundation.
+ * Copyright (C) 2008 - 2010 The GNOME Foundation.
*
* AUTHORS:
* Vivien Malerba <malerba gnome-db org>
@@ -91,7 +91,7 @@ objattrs_unref (ObjAttrs *attrs)
}
/**
- * gda_attributes_manager_new
+ * gda_attributes_manager_new:
* @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
@@ -99,6 +99,7 @@ objattrs_unref (ObjAttrs *attrs)
* Creates a new #GdaAttributesManager, which can store (name, value) attributes for pointers or GObject objects
* (in the latter case, the attibutes are destroyed when objects are also destroyed).
*
+ * Free-function: gda_attributes_manager_free
* Returns: the new #GdaAttributesManager
*/
GdaAttributesManager *
@@ -142,7 +143,7 @@ foreach_destroy_func (gpointer ptr, ObjAttrs *attrs, GdaAttributesManager *mgr)
}
/**
- * gda_attributes_manager_free
+ * gda_attributes_manager_free:
* @mgr: a #GdaAttributesManager
*
* Frees all the resssources managed by @mgr
@@ -246,7 +247,7 @@ manager_real_set (GdaAttributesManager *mgr, gpointer ptr,
}
/**
- * gda_attributes_manager_set
+ * gda_attributes_manager_set:
* @mgr: a #GdaAttributesManager
* @ptr: a pointer to the ressources to which the attribute will apply
* @att_name: an attribute's name
@@ -268,7 +269,7 @@ gda_attributes_manager_set (GdaAttributesManager *mgr, gpointer ptr, const gchar
}
/**
- * gda_attributes_manager_set_full
+ * gda_attributes_manager_set_full:
* @mgr: a #GdaAttributesManager
* @ptr: a pointer to the ressources to which the attribute will apply
* @att_name: an attribute's name
@@ -287,14 +288,14 @@ gda_attributes_manager_set_full (GdaAttributesManager *mgr, gpointer ptr,
/**
- * gda_attributes_manager_get
+ * gda_attributes_manager_get:
* @mgr: a #GdaAttributesManager
* @ptr: a pointer to the ressources to which the attribute will apply
* @att_name: an attribute's name, as a *static* string
*
* Retreives the value of an attribute previously set using gda_attributes_manager_set().
*
- * Returns: the attribute's value, or %NULL if the attribute is not set.
+ * Returns: (tranfer none): the attribute's value, or %NULL if the attribute is not set.
*/
const GValue *
gda_attributes_manager_get (GdaAttributesManager *mgr, gpointer ptr, const gchar *att_name)
@@ -316,7 +317,7 @@ gda_attributes_manager_get (GdaAttributesManager *mgr, gpointer ptr, const gchar
}
/**
- * gda_attributes_manager_copy
+ * gda_attributes_manager_copy:
* @from_mgr: a #GdaAttributesManager
* @from: a pointer from which attributes are copied
* @to_mgr: a #GdaAttributesManager
@@ -375,7 +376,7 @@ foreach_copy_func (AttName *attname, const GValue *value, CopyData *cdata)
}
/**
- * gda_attributes_manager_clear
+ * gda_attributes_manager_clear:
* @mgr: a #GdaAttributesManager
* @ptr: a pointer to the ressources for which all the attributes will be removed
*
@@ -404,7 +405,7 @@ typedef struct {
static void foreach_foreach_func (AttName *attname, const GValue *value, FData *fdata);
/**
- * gda_attributes_manager_foreach
+ * gda_attributes_manager_foreach:
* @mgr: a #GdaAttributesManager
* @ptr: a pointer to the ressources for which all the attributes used
* @func: a #GdaAttributesManagerFunc function
diff --git a/libgda/gda-batch.c b/libgda/gda-batch.c
index c26f82f..859534c 100644
--- a/libgda/gda-batch.c
+++ b/libgda/gda-batch.c
@@ -1,6 +1,6 @@
/* gda-batch.c
*
- * Copyright (C) 2007 Vivien Malerba
+ * Copyright (C) 2007 - 2010 Vivien Malerba
*
* This Library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public License as
@@ -146,7 +146,7 @@ gda_batch_init (GdaBatch * batch)
}
/**
- * gda_batch_new
+ * gda_batch_new:
*
* Creates a new #GdaBatch object
*
@@ -163,7 +163,7 @@ gda_batch_new (void)
/**
- * gda_batch_copy
+ * gda_batch_copy:
* @orig: a #GdaBatch to make a copy of
*
* Copy constructor
@@ -276,7 +276,7 @@ stmt_reset_cb (GdaStatement *stmt, GdaBatch *batch)
}
/**
- * gda_batch_add_statement
+ * gda_batch_add_statement:
* @batch: a #GdaBatch object
* @stmt: a statement to add to @batch's statements list
*
@@ -298,7 +298,7 @@ gda_batch_add_statement (GdaBatch *batch, GdaStatement *stmt)
}
/**
- * gda_batch_remove_statement
+ * gda_batch_remove_statement:
* @batch: a #GdaBatch object
* @stmt: a statement to remove from @batch's statements list
*
@@ -327,7 +327,7 @@ gda_batch_remove_statement (GdaBatch *batch, GdaStatement *stmt)
/**
- * gda_batch_serialize
+ * gda_batch_serialize:
* @batch: a #GdaBatch object
*
* Creates a string representing the contents of @batch.
@@ -367,12 +367,12 @@ gda_batch_serialize (GdaBatch *batch)
}
/**
- * gda_batch_get_statements
+ * gda_batch_get_statements:
* @batch: a #GdaBatch object
*
* Get a list of the #GdaStatement objects contained in @batch
*
- * Returns: a list of #GdaStatement which should not be modified.
+ * Returns: (element-type GdaStatement) (transfer none): a list of #GdaStatement which should not be modified.
*/
const GSList *
gda_batch_get_statements (GdaBatch *batch)
@@ -384,9 +384,9 @@ gda_batch_get_statements (GdaBatch *batch)
}
/**
- * gda_batch_get_parameters
+ * gda_batch_get_parameters:
* @batch: a #GdaBatch object
- * @out_params: a place to store a new #GdaSet object, or %NULL
+ * @out_params: (out) (tranfer 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-blob-op.c b/libgda/gda-blob-op.c
index 7aeac97..f7a5d7c 100644
--- a/libgda/gda-blob-op.c
+++ b/libgda/gda-blob-op.c
@@ -1,5 +1,5 @@
-/* GDA Common Library
- * Copyright (C) 2007 The GNOME Foundation.
+/* Gda blob
+ * Copyright (C) 2007 - 2010 The GNOME Foundation.
*
* Authors:
* Vivien Malerba <malerba gnome-db org>
@@ -90,7 +90,7 @@ gda_blob_op_finalize (GObject *object)
/**
- * gda_blob_op_get_length
+ * gda_blob_op_get_length:
* @op: an existing #GdaBlobOp
*
* Returns: the length of the blob in bytes. In case of error, -1 is returned and the
@@ -108,7 +108,7 @@ gda_blob_op_get_length (GdaBlobOp *op)
}
/**
- * gda_blob_op_read
+ * gda_blob_op_read:
* @op: a #GdaBlobOp
* @blob: a #GdaBlob to read data to
* @offset: offset to read from the start of the blob (starts at 0)
@@ -131,7 +131,7 @@ gda_blob_op_read (GdaBlobOp *op, GdaBlob *blob, glong offset, glong size)
}
/**
- * gda_blob_op_read_all
+ * gda_blob_op_read_all:
* @op: a #GdaBlobOp
* @blob: a #GdaBlob to read data to
*
@@ -154,7 +154,7 @@ gda_blob_op_read_all (GdaBlobOp *op, GdaBlob *blob)
}
/**
- * gda_blob_op_write
+ * gda_blob_op_write:
* @op: a #GdaBlobOp
* @blob: a #GdaBlob which contains the data to write
* @offset: offset to write from the start of the blob (starts at 0)
@@ -180,7 +180,7 @@ gda_blob_op_write (GdaBlobOp *op, GdaBlob *blob, glong offset)
}
/**
- * gda_blob_op_write_all
+ * gda_blob_op_write_all:
* @op: a #GdaBlobOp
* @blob: a #GdaBlob which contains the data to write
*
diff --git a/libgda/gda-column.c b/libgda/gda-column.c
index 3467586..85ce4d8 100644
--- a/libgda/gda-column.c
+++ b/libgda/gda-column.c
@@ -1,5 +1,5 @@
/* GDA library
- * Copyright (C) 1998 - 2008 The GNOME Foundation.
+ * Copyright (C) 1998 - 2010 The GNOME Foundation.
*
* AUTHORS:
* Michael Lausch <michael lausch at>
@@ -247,7 +247,7 @@ gda_column_get_property (GObject *object,
}
/**
- * gda_column_new
+ * gda_column_new:
*
* Returns: a newly allocated #GdaColumn object.
*/
@@ -262,10 +262,11 @@ gda_column_new (void)
}
/**
- * gda_column_copy
+ * gda_column_copy:
* @column: column to get a copy from.
*
- * Creates a new #GdaColumn object from an existing one.
+ * Creates a new #GdaColumn object from an existing one.
+ *
* Returns: a newly allocated #GdaColumn with a copy of the data
* in @column.
*/
@@ -294,7 +295,7 @@ gda_column_copy (GdaColumn *column)
}
/**
- * gda_column_get_name
+ * gda_column_get_name:
* @column: a #GdaColumn.
*
* Returns: the name of @column.
@@ -312,7 +313,7 @@ gda_column_get_name (GdaColumn *column)
}
/**
- * gda_column_set_name
+ * gda_column_set_name:
* @column: a #GdaColumn.
* @name: the new name of @column.
*
@@ -344,7 +345,7 @@ gda_column_set_name (GdaColumn *column, const gchar *name)
}
/**
- * gda_column_get_description
+ * gda_column_get_description:
* @column: a #GdaColumn.
*
* Returns: the column's description, in any
@@ -362,7 +363,7 @@ gda_column_get_description (GdaColumn *column)
}
/**
- * gda_column_set_description
+ * gda_column_set_description:
* @column: a #GdaColumn.
* @title: title name.
*
@@ -383,7 +384,7 @@ gda_column_set_description (GdaColumn *column, const gchar *descr)
}
/**
- * gda_column_get_dbms_type
+ * gda_column_get_dbms_type:
* @column: a #GdaColumn.
*
* Returns: the database type of @column.
@@ -396,7 +397,7 @@ gda_column_get_dbms_type (GdaColumn *column)
}
/**
- * gda_column_set_dbms_type
+ * gda_column_set_dbms_type:
* @column: a #GdaColumn
* @dbms_type: a string
*
@@ -417,7 +418,7 @@ gda_column_set_dbms_type (GdaColumn *column, const gchar *dbms_type)
}
/**
- * gda_column_get_g_type
+ * gda_column_get_g_type:
* @column: a #GdaColumn.
*
* Returns: the type of @column.
@@ -430,7 +431,7 @@ gda_column_get_g_type (GdaColumn *column)
}
/**
- * gda_column_set_g_type
+ * gda_column_set_g_type:
* @column: a #GdaColumn.
* @type: the new type of @column.
*
@@ -452,7 +453,7 @@ gda_column_set_g_type (GdaColumn *column, GType type)
}
/**
- * gda_column_get_allow_null
+ * gda_column_get_allow_null:
* @column: a #GdaColumn.
*
* Gets the 'allow null' flag of the given column.
@@ -467,7 +468,7 @@ gda_column_get_allow_null (GdaColumn *column)
}
/**
- * gda_column_set_allow_null
+ * gda_column_set_allow_null:
* @column: a #GdaColumn.
* @allow: whether the given column should allows null values or not.
*
@@ -481,7 +482,7 @@ gda_column_set_allow_null (GdaColumn *column, gboolean allow)
}
/**
- * gda_column_get_auto_increment
+ * gda_column_get_auto_increment:
* @column: a #GdaColumn.
*
* Returns: whether the given column is an auto incremented one (%TRUE or %FALSE).
@@ -494,7 +495,7 @@ gda_column_get_auto_increment (GdaColumn *column)
}
/**
- * gda_column_set_auto_increment
+ * gda_column_set_auto_increment:
* @column: a #GdaColumn.
* @is_auto: auto increment status.
*
@@ -509,7 +510,7 @@ gda_column_set_auto_increment (GdaColumn *column,
}
/**
- * gda_column_get_position
+ * gda_column_get_position:
* @column: a #GdaColumn.
*
* Returns: the position of the column refer to in the
@@ -523,7 +524,7 @@ gda_column_get_position (GdaColumn *column)
}
/**
- * gda_column_set_position
+ * gda_column_set_position:
* @column: a #GdaColumn.
* @position: the wanted position of the column in the containing data model.
*
@@ -539,7 +540,7 @@ gda_column_set_position (GdaColumn *column, gint position)
/**
- * gda_column_get_default_value
+ * gda_column_get_default_value:
* @column: a #GdaColumn.
*
* Returns: @column's default value, as a #GValue object.
@@ -552,7 +553,7 @@ gda_column_get_default_value (GdaColumn *column)
}
/**
- * gda_column_set_default_value
+ * gda_column_set_default_value:
* @column: a #GdaColumn.
* @default_value: default #GValue for the column
*
@@ -570,7 +571,7 @@ gda_column_set_default_value (GdaColumn *column, const GValue *default_value)
}
/**
- * gda_column_get_attribute
+ * gda_column_get_attribute:
* @column: a #GdaColumn
* @attribute: attribute name as a string
*
@@ -588,7 +589,7 @@ gda_column_get_attribute (GdaColumn *column, const gchar *attribute)
}
/**
- * gda_column_set_attribute
+ * gda_column_set_attribute:
* @column: a #GdaColumn
* @attribute: attribute name as a static string
* @value: a #GValue, or %NULL
diff --git a/libgda/gda-config.c b/libgda/gda-config.c
index 8733ae4..d021b61 100644
--- a/libgda/gda-config.c
+++ b/libgda/gda-config.c
@@ -709,7 +709,7 @@ GQuark gda_config_error_quark (void)
}
/**
- * gda_config_get_type
+ * gda_config_get_type:
*
* Registers the #GdaConfig class on the GLib type system.
*
diff --git a/libgda/gda-connection-event.c b/libgda/gda-connection-event.c
index 6a48884..b5c8bfc 100644
--- a/libgda/gda-connection-event.c
+++ b/libgda/gda-connection-event.c
@@ -1,5 +1,5 @@
/* GDA server library
- * Copyright (C) 1998 - 2007 The GNOME Foundation.
+ * Copyright (C) 1998 - 2010 The GNOME Foundation.
*
* AUTHORS:
* Michael Lausch <michael lausch at>
@@ -192,7 +192,7 @@ static void gda_connection_event_get_property (GObject *object, guint prop_id, G
}
/**
- * gda_connection_event_set_event_type
+ * gda_connection_event_set_event_type:
* @event: a #GdaConnectionEvent object
* @type: the severity of the event
*
@@ -209,7 +209,7 @@ gda_connection_event_set_event_type (GdaConnectionEvent *event, GdaConnectionEve
}
/**
- * gda_connection_event_get_event_type
+ * gda_connection_event_get_event_type:
* @event: a #GdaConnectionEvent object
*
* Get @event's severity (from a simple notice to a fatal event)
@@ -226,7 +226,7 @@ gda_connection_event_get_event_type (GdaConnectionEvent *event)
}
/**
- * gda_connection_event_get_description
+ * gda_connection_event_get_description:
* @event: a #GdaConnectionEvent.
*
* Get the description of the event. Note that is @event's type is GDA_CONNECTION_EVENT_COMMAND,
@@ -242,7 +242,7 @@ gda_connection_event_get_description (GdaConnectionEvent *event)
}
/**
- * gda_connection_event_set_description
+ * gda_connection_event_set_description:
* @event: a #GdaConnectionEvent.
* @description: a description.
*
@@ -259,7 +259,7 @@ gda_connection_event_set_description (GdaConnectionEvent *event, const gchar *de
}
/**
- * gda_connection_event_get_code
+ * gda_connection_event_get_code:
* @event: a #GdaConnectionEvent.
*
* Returns: @event's code (the code is specific to the provider being used)
@@ -272,7 +272,7 @@ gda_connection_event_get_code (GdaConnectionEvent * event)
}
/**
- * gda_connection_event_set_code
+ * gda_connection_event_set_code:
* @event: a #GdaConnectionEvent.
* @code: a code.
*
@@ -290,7 +290,7 @@ gda_connection_event_set_code (GdaConnectionEvent *event, glong code)
}
/**
- * gda_connection_event_get_gda_code
+ * gda_connection_event_get_gda_code:
* @event: a #GdaConnectionEvent
*
* Retreive the code associated to @event.
@@ -305,7 +305,7 @@ gda_connection_event_get_gda_code (GdaConnectionEvent *event)
}
/**
- * gda_connection_event_set_gda_code
+ * gda_connection_event_set_gda_code:
* @event: a #GdaConnectionEvent
* @code: a code
*
@@ -324,7 +324,7 @@ gda_connection_event_set_gda_code (GdaConnectionEvent *event, GdaConnectionEvent
/**
- * gda_connection_event_get_source
+ * gda_connection_event_get_source:
* @event: a #GdaConnectionEvent.
*
* Returns: @event's source.
@@ -337,7 +337,7 @@ gda_connection_event_get_source (GdaConnectionEvent *event)
}
/**
- * gda_connection_event_set_source
+ * gda_connection_event_set_source:
* @event: a #GdaConnectionEvent.
* @source: a source.
*
@@ -354,7 +354,7 @@ gda_connection_event_set_source (GdaConnectionEvent *event, const gchar *source)
}
/**
- * gda_connection_event_get_sqlstate
+ * gda_connection_event_get_sqlstate:
* @event: a #GdaConnectionEvent.
*
* Get the SQLSTATE value of @event. Even though the SQLSTATE values are specified by ANSI SQL and ODBC,
@@ -372,7 +372,7 @@ gda_connection_event_get_sqlstate (GdaConnectionEvent *event)
}
/**
- * gda_connection_event_set_sqlstate
+ * gda_connection_event_set_sqlstate:
* @event: a #GdaConnectionEvent.
* @sqlstate: SQL state.
*
diff --git a/libgda/gda-data-access-wrapper.c b/libgda/gda-data-access-wrapper.c
index 0ef9f26..1c0c334 100644
--- a/libgda/gda-data-access-wrapper.c
+++ b/libgda/gda-data-access-wrapper.c
@@ -1,5 +1,5 @@
/* GDA library
- * Copyright (C) 2006 - 2008 The GNOME Foundation.
+ * Copyright (C) 2006 - 2010 The GNOME Foundation.
*
* AUTHORS:
* Vivien Malerba <malerba gnome-db org>
@@ -89,7 +89,7 @@ static GdaRow *create_new_row (GdaDataAccessWrapper *model);
static GObjectClass *parent_class = NULL;
/**
- * gda_data_access_wrapper_get_type
+ * gda_data_access_wrapper_get_type:
*
* Returns: the #GType of GdaDataAccessWrapper.
*/
@@ -351,7 +351,7 @@ gda_data_access_wrapper_get_property (GObject *object,
}
/**
- * gda_data_access_wrapper_new
+ * gda_data_access_wrapper_new:
* @model: a #GdaDataModel
*
* Creates a new #GdaDataModel object which buffers the rows of @model. This object is usefull
diff --git a/libgda/gda-data-comparator.c b/libgda/gda-data-comparator.c
index b225e2b..d5ae798 100644
--- a/libgda/gda-data-comparator.c
+++ b/libgda/gda-data-comparator.c
@@ -1,6 +1,6 @@
/* gda-data-comparator.c
*
- * Copyright (C) 2008 Vivien Malerba
+ * Copyright (C) 2008 - 2010 Vivien Malerba
*
* This Library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public License as
@@ -174,7 +174,7 @@ gda_data_comparator_init (GdaDataComparator *comparator)
}
/**
- * gda_data_comparator_new
+ * gda_data_comparator_new:
* @old_model: Data model to which the modifications should be applied
* @new_model: Target data model.
*
@@ -182,7 +182,7 @@ gda_data_comparator_init (GdaDataComparator *comparator)
* all the computed differences (as #GdaDiff structures) to @old_model, the resulting data model
* should have the same contents as @new_model.
*
- * Returns: a new #GdaDataComparator object
+ * Returns: (type GdaDataComparator) (transfer full): a new #GdaDataComparator object
*/
GObject *
gda_data_comparator_new (GdaDataModel *old_model, GdaDataModel *new_model)
@@ -327,10 +327,10 @@ gda_diff_free (GdaDiff *diff)
}
/**
- * gda_data_comparator_set_key_columns
+ * gda_data_comparator_set_key_columns:
* @comp: a #GdaDataComparator object
* @nb_cols: the size of the @col_numbers array
- * @col_numbers: a array of @nb_cols values
+ * @col_numbers: (array length=nb_cols): an array of @nb_cols values
*
* Defines the columns which will be used as a key when searching data. This is not mandatory but
* will speed things up as less data will be processed.
@@ -411,7 +411,7 @@ find_row_in_model (GdaDataComparator *comp, gint row, gboolean *out_has_changed,
}
/**
- * gda_data_comparator_compute_diff
+ * gda_data_comparator_compute_diff:
* @comp: a #GdaDataComparator object
* @error: a place to store errors, or %NULL
*
@@ -606,7 +606,7 @@ gda_data_comparator_compute_diff (GdaDataComparator *comp, GError **error)
}
/**
- * gda_data_comparator_get_n_diffs
+ * gda_data_comparator_get_n_diffs:
* @comp: a #GdaDataComparator object
*
* Get the number of differences as computed by the last time gda_data_comparator_compute_diff() was called.
@@ -623,13 +623,13 @@ gda_data_comparator_get_n_diffs (GdaDataComparator *comp)
}
/**
- * gda_data_comparator_get_diff
+ * gda_data_comparator_get_diff:
* @comp: a #GdaDataComparator object
* @pos: the requested difference number (starting at 0)
*
* Get a pointer to the #GdaDiff structure representing the difference which number is @pos
*
- * Returns: a pointer to a #GdaDiff, or %NULL if @pos is invalid
+ * Returns: (transfer none): a pointer to a #GdaDiff, or %NULL if @pos is invalid
*/
const GdaDiff *
gda_data_comparator_get_diff (GdaDataComparator *comp, gint pos)
diff --git a/libgda/gda-data-model-array.c b/libgda/gda-data-model-array.c
index edeb444..8f18c3c 100644
--- a/libgda/gda-data-model-array.c
+++ b/libgda/gda-data-model-array.c
@@ -1,5 +1,5 @@
/* GDA library
- * Copyright (C) 1998 - 2009 The GNOME Foundation.
+ * Copyright (C) 1998 - 2010 The GNOME Foundation.
*
* AUTHORS:
* Rodrigo Moya <rodrigo gnome-db org>
@@ -264,7 +264,7 @@ gda_data_model_array_get_property (GObject *object, guint prop_id, GValue *value
/**
- * gda_data_model_array_new
+ * gda_data_model_array_new:
* @cols: number of columns for rows in this data model.
*
* Creates a new #GdaDataModel object without initializing the column
@@ -282,7 +282,7 @@ gda_data_model_array_new (gint cols)
}
/**
- * gda_data_model_array_new_with_g_types
+ * gda_data_model_array_new_with_g_types:
* @cols: number of columns for rows in this data model.
* @...: types of the columns of the model to create as #GType, as many as indicated by @cols
*
@@ -316,7 +316,7 @@ gda_data_model_array_new_with_g_types (gint cols, ...)
}
/**
- * gda_data_model_array_copy_model
+ * gda_data_model_array_copy_model:
* @src: a #GdaDataModel to copy data from
* @error: a place to store errors, or %NULL
*
@@ -368,14 +368,14 @@ gda_data_model_array_copy_model (GdaDataModel *src, GError **error)
}
/**
- * gda_data_model_array_get_row
+ * gda_data_model_array_get_row:
* @model: a #GdaDataModelArray object
* @row: row number (starting from 0)
* @error: a place to store errors, or %NULL
*
* Get a pointer to a row in @model
*
- * Returns: the #GdaRow, or %NULL if an error occurred
+ * Returns: (transfer none): the #GdaRow, or %NULL if an error occurred
*/
GdaRow *
gda_data_model_array_get_row (GdaDataModelArray *model, gint row, GError **error)
@@ -397,7 +397,7 @@ gda_data_model_array_get_row (GdaDataModelArray *model, gint row, GError **error
}
/**
- * gda_data_model_array_set_n_columns
+ * gda_data_model_array_set_n_columns:
* @model: the #GdaDataModelArray.
* @cols: number of columns for rows this data model should use.
*
@@ -418,7 +418,7 @@ gda_data_model_array_set_n_columns (GdaDataModelArray *model, gint cols)
}
/**
- * gda_data_model_array_clear
+ * gda_data_model_array_clear:
* @model: the model to clear.
*
* Frees all the rows in @model.
diff --git a/libgda/gda-data-model-bdb.c b/libgda/gda-data-model-bdb.c
index 7828fe9..6473c0e 100644
--- a/libgda/gda-data-model-bdb.c
+++ b/libgda/gda-data-model-bdb.c
@@ -1,5 +1,5 @@
/* GDA Berkeley-DB data model
- * Copyright (C) 1998 - 2008 The GNOME Foundation
+ * Copyright (C) 1998 - 2010 The GNOME Foundation
*
* AUTHORS:
* Laurent Sansonetti <lrz gnome org>
@@ -459,7 +459,7 @@ gda_data_model_bdb_get_property (GObject *object,
/**
- * gda_data_model_bdb_new
+ * gda_data_model_bdb_new:
* @filename: name of the file containing the database
* @db_name: the name of the database within @filename, or %NULL
*
@@ -482,12 +482,12 @@ gda_data_model_bdb_new (const gchar *filename, const gchar *db_name)
}
/**
- * gda_data_model_bdb_get_errors
+ * gda_data_model_bdb_get_errors:
* @model: a #GdaDataModelBdb object
*
* Get the list of errors which have occurred while using @model
*
- * Returns: a read-only list of #GError pointers, or %NULL if no error has occurred
+ * Returns: (element-type GObject.Error) (transfer none): a read-only list of #GError pointers, or %NULL if no error has occurred
*/
const GSList *
gda_data_model_bdb_get_errors (GdaDataModelBdb *model)
@@ -499,7 +499,7 @@ gda_data_model_bdb_get_errors (GdaDataModelBdb *model)
}
/**
- * gda_data_model_bdb_clean_errors
+ * gda_data_model_bdb_clean_errors:
* @model: a #GdaDataModelBdb object
*
* Reset the list of errors which have occurred while using @model
diff --git a/libgda/gda-data-model.c b/libgda/gda-data-model.c
index 1af2881..f50fa44 100644
--- a/libgda/gda-data-model.c
+++ b/libgda/gda-data-model.c
@@ -1,6 +1,6 @@
/*
* GDA common library
- * Copyright (C) 1998 - 2008 The GNOME Foundation.
+ * Copyright (C) 1998 - 2010 The GNOME Foundation.
*
* AUTHORS:
* Rodrigo Moya <rodrigo gnome-db org>
@@ -216,7 +216,7 @@ _gda_data_model_signal_emit_changed (GdaDataModel *model)
}
/**
- * gda_data_model_row_inserted
+ * gda_data_model_row_inserted:
* @model: a #GdaDataModel object.
* @row: row number.
*
@@ -256,7 +256,7 @@ gda_data_model_row_inserted (GdaDataModel *model, gint row)
}
/**
- * gda_data_model_row_updated
+ * gda_data_model_row_updated:
* @model: a #GdaDataModel object.
* @row: row number.
*
@@ -280,7 +280,7 @@ gda_data_model_row_updated (GdaDataModel *model, gint row)
}
/**
- * gda_data_model_row_removed
+ * gda_data_model_row_removed:
* @model: a #GdaDataModel object.
* @row: row number.
*
@@ -304,7 +304,7 @@ gda_data_model_row_removed (GdaDataModel *model, gint row)
}
/**
- * gda_data_model_reset
+ * gda_data_model_reset:
* @model: a #GdaDataModel object.
*
* Emits the 'reset' and 'changed' signal on @model.
@@ -323,7 +323,7 @@ gda_data_model_reset (GdaDataModel *model)
}
/**
- * gda_data_model_freeze
+ * gda_data_model_freeze:
* @model: a #GdaDataModel object.
*
* Disables notifications of changes on the given data model. To
@@ -342,7 +342,7 @@ gda_data_model_freeze (GdaDataModel *model)
}
/**
- * gda_data_model_thaw
+ * gda_data_model_thaw:
* @model: a #GdaDataModel object.
*
* Re-enables notifications of changes on the given data model.
@@ -359,12 +359,12 @@ gda_data_model_thaw (GdaDataModel *model)
}
/**
- * gda_data_model_get_access_flags
+ * gda_data_model_get_access_flags:
* @model: a #GdaDataModel object.
*
* Get the attributes of @model such as how to access the data it contains if it's modifiable, etc.
*
- * Returns: an ORed value of #GdaDataModelAccessFlags flags
+ * Returns: (transfer none): an ORed value of #GdaDataModelAccessFlags flags
*/
GdaDataModelAccessFlags
gda_data_model_get_access_flags (GdaDataModel *model)
@@ -381,7 +381,7 @@ gda_data_model_get_access_flags (GdaDataModel *model)
}
/**
- * gda_data_model_get_n_rows
+ * gda_data_model_get_n_rows:
* @model: a #GdaDataModel object.
*
* Returns: the number of rows in the given data model, or -1 if the number of rows is not known
@@ -398,7 +398,7 @@ gda_data_model_get_n_rows (GdaDataModel *model)
}
/**
- * gda_data_model_get_n_columns
+ * gda_data_model_get_n_columns:
* @model: a #GdaDataModel object.
*
* Returns: the number of columns in the given data model.
@@ -418,7 +418,7 @@ gda_data_model_get_n_columns (GdaDataModel *model)
}
/**
- * gda_data_model_describe_column
+ * gda_data_model_describe_column:
* @model: a #GdaDataModel object.
* @col: column number.
*
@@ -430,7 +430,7 @@ gda_data_model_get_n_columns (GdaDataModel *model)
* WARNING: the returned #GdaColumn object belongs to the @model model and
* and should not be destroyed; any modification will affect the whole data model.
*
- * Returns: the description of the column.
+ * Returns: (transfer none): the description of the column.
*/
GdaColumn *
gda_data_model_describe_column (GdaDataModel *model, gint col)
@@ -447,7 +447,7 @@ gda_data_model_describe_column (GdaDataModel *model, gint col)
}
/**
- * gda_data_model_get_column_index
+ * gda_data_model_get_column_index:
* @model: a #GdaDataModel object.
* @name: a column name
*
@@ -477,7 +477,7 @@ gda_data_model_get_column_index (GdaDataModel *model, const gchar *name)
}
/**
- * gda_data_model_get_column_name
+ * gda_data_model_get_column_name:
* @model: a #GdaDataModel object.
* @col: column number.
*
@@ -501,7 +501,7 @@ gda_data_model_get_column_name (GdaDataModel *model, gint col)
}
/**
- * gda_data_model_set_column_name
+ * gda_data_model_set_column_name:
* @model: a #GdaDataModel object.
* @col: column number
* @name: name for the given column.
@@ -529,7 +529,7 @@ gda_data_model_set_column_name (GdaDataModel *model, gint col, const gchar *name
/**
- * gda_data_model_get_column_title
+ * gda_data_model_get_column_title:
* @model: a #GdaDataModel object.
* @col: column number.
*
@@ -551,7 +551,7 @@ gda_data_model_get_column_title (GdaDataModel *model, gint col)
}
/**
- * gda_data_model_set_column_title
+ * gda_data_model_set_column_title:
* @model: a #GdaDataModel object.
* @col: column number
* @title: title for the given column.
@@ -572,7 +572,7 @@ gda_data_model_set_column_title (GdaDataModel *model, gint col, const gchar *tit
}
/**
- * gda_data_model_get_value_at
+ * gda_data_model_get_value_at:
* @model: a #GdaDataModel object.
* @col: a valid column number.
* @row: a valid row number.
@@ -596,7 +596,7 @@ gda_data_model_set_column_title (GdaDataModel *model, gint col, const gchar *tit
* If you want to modify a value stored in a #GdaDataModel, use the gda_data_model_set_value_at() or
* gda_data_model_set_values() methods.
*
- * Returns: a #GValue containing the value stored in the given
+ * Returns: (transfer none): a #GValue containing the value stored in the given
* position, or %NULL on error (out-of-bound position, etc).
*/
const GValue *
@@ -615,7 +615,7 @@ gda_data_model_get_value_at (GdaDataModel *model, gint col, gint row, GError **e
}
/**
- * gda_data_model_get_typed_value_at
+ * gda_data_model_get_typed_value_at:
* @model: a #GdaDataModel object.
* @col: a valid column number.
* @row: a valid row number.
@@ -665,7 +665,7 @@ gda_data_model_get_typed_value_at (GdaDataModel *model, gint col, gint row, GTyp
}
/**
- * gda_data_model_get_attributes_at
+ * gda_data_model_get_attributes_at:
* @model: a #GdaDataModel object
* @col: a valid column number
* @row: a valid row number, or -1
@@ -675,7 +675,7 @@ gda_data_model_get_typed_value_at (GdaDataModel *model, gint col, gint row, GTyp
* @row is -1, then the attributes returned correspond to a "would be" value
* if a row was added to @model.
*
- * Returns: the attributes as an ORed value of #GdaValueAttribute
+ * Returns: (transfer none): the attributes as an ORed value of #GdaValueAttribute
*/
GdaValueAttribute
gda_data_model_get_attributes_at (GdaDataModel *model, gint col, gint row)
@@ -689,7 +689,7 @@ gda_data_model_get_attributes_at (GdaDataModel *model, gint col, gint row)
}
/**
- * gda_data_model_set_value_at
+ * gda_data_model_set_value_at:
* @model: a #GdaDataModel object.
* @col: column number.
* @row: row number.
@@ -716,10 +716,10 @@ gda_data_model_set_value_at (GdaDataModel *model, gint col, gint row, const GVal
}
/**
- * gda_data_model_set_values
+ * gda_data_model_set_values:
* @model: a #GdaDataModel object.
* @row: row number.
- * @values: a list of #GValue, one for at most the number of columns of @model
+ * @values: (element-type GObject.Value) (transfer none): a list of #GValue, one for at most the number of columns of @model
* @error: a place to store errors, or %NULL
*
* In a similar way to gda_data_model_set_value_at(), this method modifies a data model's contents
@@ -746,7 +746,7 @@ gda_data_model_set_values (GdaDataModel *model, gint row, GList *values, GError
}
/**
- * gda_data_model_create_iter
+ * gda_data_model_create_iter:
* @model: a #GdaDataModel object.
*
* Creates a new iterator object #GdaDataModelIter object which can be used to iterate through
@@ -763,7 +763,7 @@ gda_data_model_set_values (GdaDataModel *model, gint row, GList *values, GError
* gda_data_model_iter_move_next() (and gda_data_model_iter_move_prev() if
* supported).
*
- * Returns: a #GdaDataModelIter object, or %NULL if an error occurred
+ * Returns: (transfer full): a #GdaDataModelIter object, or %NULL if an error occurred
*/
GdaDataModelIter *
gda_data_model_create_iter (GdaDataModel *model)
@@ -778,9 +778,9 @@ gda_data_model_create_iter (GdaDataModel *model)
}
/**
- * gda_data_model_append_values
+ * gda_data_model_append_values:
* @model: a #GdaDataModel object.
- * @values: #GList of #GValue* representing the row to add. The
+ * @values: (element-type GObject.Value): #GList of #GValue* representing the row to add. The
* length must match model's column count. These #GValue
* are value-copied (the user is still responsible for freeing them).
* @error: a place to store errors, or %NULL
@@ -806,7 +806,7 @@ gda_data_model_append_values (GdaDataModel *model, const GList *values, GError *
}
/**
- * gda_data_model_append_row
+ * gda_data_model_append_row:
* @model: a #GdaDataModel object.
* @error: a place to store errors, or %NULL
*
@@ -838,7 +838,7 @@ gda_data_model_append_row (GdaDataModel *model, GError **error)
/**
- * gda_data_model_remove_row
+ * gda_data_model_remove_row:
* @model: a #GdaDataModel object.
* @row: the row number to be removed.
* @error: a place to store errors, or %NULL
@@ -869,10 +869,10 @@ gda_data_model_remove_row (GdaDataModel *model, gint row, GError **error)
}
/**
- * gda_data_model_get_row_from_values
+ * gda_data_model_get_row_from_values:
* @model: a #GdaDataModel object.
- * @values: a list of #GValue values (no %NULL is allowed)
- * @cols_index: an array of #gint containing the column number to match each value of @values
+ * @values: (element-type Gobject.Value): a list of #GValue values (no %NULL is allowed)
+ * @cols_index: (array): an array of #gint containing the column number to match each value of @values
*
* Returns the first row where all the values in @values at the columns identified at
* @cols_index match. If the row can't be identified, then returns -1;
@@ -940,9 +940,9 @@ gda_data_model_get_row_from_values (GdaDataModel *model, GSList *values, gint *c
}
/**
- * gda_data_model_send_hint
+ * gda_data_model_send_hint:
* @model: a #GdaDataModel
- * @hint: a hint to send to the model
+ * @hint: (transfer none): a hint to send to the model
* @hint_value: an optional value to specify the hint, or %NULL
*
* Sends a hint to the data model. The hint may or may not be handled by the data
@@ -962,12 +962,12 @@ static gchar *export_to_text_separated (GdaDataModel *model, const gint *cols, g
/**
- * gda_data_model_export_to_string
+ * gda_data_model_export_to_string:
* @model: a #GdaDataModel
* @format: the format in which to export data
- * @cols: an array containing which columns of @model will be exported, or %NULL for all columns
+ * @cols: (array length=nb_cols): an array containing which columns of @model will be exported, or %NULL for all columns
* @nb_cols: the number of columns in @cols
- * @rows: an array containing which rows of @model will be exported, or %NULL for all rows
+ * @rows: (array length=nb_rows): an array containing which rows of @model will be exported, or %NULL for all rows
* @nb_rows: the number of rows in @rows
* @options: list of options for the export
*
@@ -1096,13 +1096,13 @@ gda_data_model_export_to_string (GdaDataModel *model, GdaDataModelIOFormat forma
}
/**
- * gda_data_model_export_to_file
+ * gda_data_model_export_to_file:
* @model: a #GdaDataModel
* @format: the format in which to export data
* @file: the filename to export to
- * @cols: an array containing which columns of @model will be exported, or %NULL for all columns
+ * @cols: (array length=nb_cols): an array containing which columns of @model will be exported, or %NULL for all columns
* @nb_cols: the number of columns in @cols
- * @rows: an array containing which rows of @model will be exported, or %NULL for all rows
+ * @rows: (array length=nb_rows): an array containing which rows of @model will be exported, or %NULL for all rows
* @nb_rows: the number of rows in @rows
* @options: list of options for the export
* @error: a place to store errors, or %NULL
@@ -1479,7 +1479,7 @@ add_xml_row (GdaDataModel *model, xmlNodePtr xml_row, GError **error)
}
/**
- * gda_data_model_add_data_from_xml_node
+ * gda_data_model_add_data_from_xml_node:
* @model: a #GdaDataModel.
* @node: an XML node representing a <gda_array_data> XML node.
* @error: a place to store errors, or %NULL
@@ -1517,11 +1517,11 @@ gda_data_model_add_data_from_xml_node (GdaDataModel *model, xmlNodePtr node, GEr
}
/**
- * gda_data_model_import_from_model
+ * gda_data_model_import_from_model:
* @to: the destination #GdaDataModel
* @from: the source #GdaDataModel
* @overwrite: TRUE if @to is completely overwritten by @from's data, and FALSE if @from's data is appended to @to
- * @cols_trans: a #GHashTable for columns translating, or %NULL
+ * @cols_trans: (element-type gint gint): a #GHashTable for columns translating, or %NULL
* @error: a place to store errors, or %NULL
*
* Copy the contents of the @from data model to the @to data model. The copy stops as soon as an error
@@ -1772,10 +1772,10 @@ gda_data_model_import_from_model (GdaDataModel *to, GdaDataModel *from,
}
/**
- * gda_data_model_import_from_string
+ * gda_data_model_import_from_string:
* @model: a #GdaDataModel
* @string: the string to import data from
- * @cols_trans: a hash table containing which columns of @model will be imported, or %NULL for all columns
+ * @cols_trans: (element-type gint gint): a hash table containing which columns of @model will be imported, or %NULL for all columns, see gda_data_model_import_from_model()
* @options: list of options for the export
* @error: a place to store errors, or %NULL
*
@@ -1804,10 +1804,10 @@ gda_data_model_import_from_string (GdaDataModel *model,
}
/**
- * gda_data_model_import_from_file
+ * gda_data_model_import_from_file:
* @model: a #GdaDataModel
* @file: the filename to import from
- * @cols_trans: a #GHashTable for columns translating, or %NULL
+ * @cols_trans: (element-type gint gint): a #GHashTable for columns translating, or %NULL, see gda_data_model_import_from_model()
* @options: list of options for the export
* @error: a place to store errors, or %NULL
*
@@ -1840,7 +1840,7 @@ static gchar *real_gda_data_model_dump_as_string (GdaDataModel *model, gboolean
GError **error);
/**
- * gda_data_model_dump
+ * gda_data_model_dump:
* @model: a #GdaDataModel.
* @to_stream: where to dump the data model
*
@@ -1904,7 +1904,7 @@ gda_data_model_dump (GdaDataModel *model, FILE *to_stream)
}
/**
- * gda_data_model_dump_as_string
+ * gda_data_model_dump_as_string:
* @model: a #GdaDataModel.
*
* Dumps a textual representation of the @model into a new string
diff --git a/libgda/gda-set.c b/libgda/gda-set.c
index 473be5a..322c4f5 100644
--- a/libgda/gda-set.c
+++ b/libgda/gda-set.c
@@ -1,6 +1,6 @@
/* gda-set.c
*
- * Copyright (C) 2003 - 2008 Vivien Malerba
+ * Copyright (C) 2003 - 2010 Vivien Malerba
*
* This Library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public License as
@@ -349,8 +349,8 @@ gda_set_init (GdaSet *set)
/**
- * gda_set_new
- * @holders: a list of #GdaHolder objects
+ * gda_set_new:
+ * @holders: (element-type GdaHolder) (transfer:none): a list of #GdaHolder objects
*
* Creates a new #GdaSet object, and populates it with the list given as argument.
* The list can then be freed as it is copied. All the value holders in @holders are referenced counted
@@ -369,7 +369,7 @@ gda_set_new (GSList *holders)
}
/**
- * gda_set_copy
+ * gda_set_copy:
* @set: a #GdaSet object
*
* Creates a new #GdaSet object, opy of @set
@@ -395,7 +395,7 @@ gda_set_copy (GdaSet *set)
}
/**
- * gda_set_new_inline
+ * gda_set_new_inline:
* @nb: the number of value holders which will be contained in the new #GdaSet
* @...: a serie of a (const gchar*) id, (GType) type, and value
*
@@ -502,7 +502,7 @@ gda_set_new_inline (gint nb, ...)
}
/**
- * gda_set_set_holder_value
+ * gda_set_set_holder_value:
* @set: a #GdaSet object
* @error: a place to store errors, or %NULL
* @holder_id: the ID of the holder to set the value
@@ -583,7 +583,7 @@ gda_set_set_holder_value (GdaSet *set, GError **error, const gchar *holder_id, .
}
/**
- * gda_set_get_holder_value
+ * gda_set_get_holder_value:
* @set: a #GdaSet object
* @holder_id: the ID of the holder to set the value
*
@@ -630,7 +630,7 @@ xml_validity_error_func (void *ctx, const char *msg, ...)
}
/**
- * gda_set_new_from_spec_string
+ * gda_set_new_from_spec_string:
* @xml_spec: a string
* @error: a place to store the error, or %NULL
*
@@ -722,7 +722,7 @@ gda_set_new_from_spec_string (const gchar *xml_spec, GError **error)
/**
- * gda_set_new_from_spec_node
+ * gda_set_new_from_spec_node:
* @xml_spec: a #xmlNodePtr for a <holders> tag
* @error: a place to store the error, or %NULL
*
@@ -882,9 +882,11 @@ gda_set_new_from_spec_node (xmlNodePtr xml_spec, GError **error)
}
/**
- * gda_set_remove_holder
- * @set:
- * @holder:
+ * gda_set_remove_holder:
+ * @set: a #GdaSet object
+ * @holder: the #GdaHolder to remove from @set
+ *
+ * Removes a #GdaHolder from the list of holders managed by @set
*/
void
gda_set_remove_holder (GdaSet *set, GdaHolder *holder)
@@ -1131,7 +1133,7 @@ compute_public_data (GdaSet *set)
}
/**
- * gda_set_add_holder
+ * gda_set_add_holder:
* @set: a #GdaSet object
* @holder: a #GdaHolder object
*
@@ -1202,7 +1204,7 @@ gda_set_real_add_holder (GdaSet *set, GdaHolder *holder)
/**
- * gda_set_merge_with_set
+ * gda_set_merge_with_set:
* @set: a #GdaSet object
* @set_to_merge: a #GdaSet object
*
@@ -1247,7 +1249,7 @@ set_remove_source (GdaSet *set, GdaSetSource *source)
}
/**
- * gda_set_is_valid
+ * gda_set_is_valid:
* @set: a #GdaSet object
* @error: a place to store validation errors, or %NULL
*
@@ -1299,13 +1301,13 @@ _gda_set_validate (GdaSet *set, GError **error)
/**
- * gda_set_get_holder
+ * gda_set_get_holder:
* @set: a #GdaSet object
* @holder_id: the ID of the requested value holder
*
* Finds a #GdaHolder using its ID
*
- * Returns: a #GdaHolder or %NULL
+ * Returns: (transfer none): the requested #GdaHolder or %NULL
*/
GdaHolder *
gda_set_get_holder (GdaSet *set, const gchar *holder_id)
@@ -1316,15 +1318,14 @@ gda_set_get_holder (GdaSet *set, const gchar *holder_id)
return (GdaHolder *) g_hash_table_lookup (set->priv->holders_hash, holder_id);
}
-
/**
- * gda_set_get_node
+ * gda_set_get_node:
* @set: a #GdaSet object
* @holder: a #GdaHolder object
*
* Finds a #GdaSetNode holding information for @holder, don't modify the returned structure
*
- * Returns: a #GdaSetNode or %NULL
+ * Returns: (transfer none): the requested #GdaSetNode or %NULL
*/
GdaSetNode *
gda_set_get_node (GdaSet *set, GdaHolder *holder)
@@ -1346,14 +1347,14 @@ gda_set_get_node (GdaSet *set, GdaHolder *holder)
}
/**
- * gda_set_get_source
+ * gda_set_get_source:
* @set: a #GdaSet object
* @holder: a #GdaHolder object
*
* Finds a #GdaSetSource which contains the #GdaDataModel restricting the possible values of
* @holder, don't modify the returned structure.
*
- * Returns: a #GdaSetSource or %NULL
+ * Returns: (transfer none): the requested #GdaSetSource or %NULL
*/
GdaSetSource *
gda_set_get_source (GdaSet *set, GdaHolder *holder)
@@ -1368,14 +1369,14 @@ gda_set_get_source (GdaSet *set, GdaHolder *holder)
}
/**
- * gda_set_get_group
+ * gda_set_get_group:
* @set: a #GdaSet object
* @holder: a #GdaHolder object
*
* Finds a #GdaSetGroup which lists a #GdaSetNode containing @holder,
* don't modify the returned structure.
*
- * Returns: a #GdaSetGroup or %NULL
+ * Returns: (transfer none): the requested #GdaSetGroup or %NULL
*/
GdaSetGroup *
gda_set_get_group (GdaSet *set, GdaHolder *holder)
@@ -1403,14 +1404,14 @@ gda_set_get_group (GdaSet *set, GdaHolder *holder)
/**
- * gda_set_get_source_for_model
+ * gda_set_get_source_for_model:
* @set: a #GdaSet object
* @model: a #GdaDataModel object
*
* Finds the #GdaSetSource structure used in @set for which @model is a
* the data model (the returned structure should not be modified).
*
- * Returns: a #GdaSetSource pointer or %NULL.
+ * Returns: (transfer none): the requested #GdaSetSource pointer or %NULL.
*/
GdaSetSource *
gda_set_get_source_for_model (GdaSet *set, GdaDataModel *model)
diff --git a/libgda/gda-statement.c b/libgda/gda-statement.c
index 61e4771..723b3bb 100644
--- a/libgda/gda-statement.c
+++ b/libgda/gda-statement.c
@@ -1,6 +1,6 @@
/* gda-statement.c
*
- * Copyright (C) 2007 - 2008 Vivien Malerba
+ * Copyright (C) 2007 - 2010 Vivien Malerba
*
* This Library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public License as
@@ -177,7 +177,7 @@ gda_statement_init (GdaStatement * stmt)
}
/**
- * gda_statement_new
+ * gda_statement_new:
*
* Creates a new #GdaStatement object
*
@@ -194,7 +194,7 @@ gda_statement_new (void)
/**
- * gda_statement_copy
+ * gda_statement_copy:
* @orig: a #GdaStatement to make a copy of
*
* Copy constructor
@@ -299,13 +299,13 @@ gda_statement_get_property (GObject *object,
}
/**
- * gda_statement_get_statement_type
+ * gda_statement_get_statement_type:
* @stmt: a #GdaStatement object
*
* Get the type of statement held by @stmt. It returns GDA_SQL_STATEMENT_NONE if
* @stmt does not hold any statement
*
- * Returns: the statement type
+ * Returns: (transfer none): the statement type
*/
GdaSqlStatementType
gda_statement_get_statement_type (GdaStatement *stmt)
@@ -320,7 +320,7 @@ gda_statement_get_statement_type (GdaStatement *stmt)
}
/**
- * gda_statement_is_useless
+ * gda_statement_is_useless:
* @stmt: a #GdaStatement object
*
* Tells if @stmt is composed only of spaces (that is it has no real SQL code), and is completely
@@ -364,7 +364,7 @@ gda_statement_is_useless (GdaStatement *stmt)
}
/**
- * gda_statement_check_structure
+ * gda_statement_check_structure:
* @stmt: a #GdaStatement object
* @error: a place to store errors, or %NULL
*
@@ -382,9 +382,9 @@ gda_statement_check_structure (GdaStatement *stmt, GError **error)
}
/**
- * gda_statement_check_validity
+ * gda_statement_check_validity:
* @stmt: a #GdaStatement object
- * @cnc: a #GdaConnection object, or %NULL
+ * @cnc: (allow-none): a #GdaConnection object, or %NULL
* @error: a place to store errors, or %NULL
*
* If @cnc is not %NULL then checks that every object (table, field, function) used in @stmt
@@ -411,7 +411,7 @@ gda_statement_check_validity (GdaStatement *stmt, GdaConnection *cnc, GError **e
}
/**
- * gda_statement_normalize
+ * gda_statement_normalize:
* @stmt: a #GdaStatement object
* @cnc: a #GdaConnection object
* @error: a place to store errors, or %NULL
@@ -432,7 +432,7 @@ gda_statement_normalize (GdaStatement *stmt, GdaConnection *cnc, GError **error)
}
/**
- * gda_statement_serialize
+ * gda_statement_serialize:
* @stmt: a #GdaStatement object
*
* Creates a string representing the contents of @stmt.
@@ -496,9 +496,9 @@ get_params_foreach_func (GdaSqlAnyPart *node, GdaSet **params, GError **error)
}
/**
- * gda_statement_get_parameters
+ * gda_statement_get_parameters:
* @stmt: a #GdaStatement object
- * @out_params: a place to store a new #GdaSet object, or %NULL
+ * @out_params: (out) (allow-none) (transfer full): 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
@@ -562,7 +562,7 @@ static gchar *default_render_select_from (GdaSqlSelectFrom *from, GdaSqlRenderin
static gchar *default_render_select_order (GdaSqlSelectOrder *order, GdaSqlRenderingContext *context, GError **error);
/**
- * gda_statement_to_sql_real
+ * gda_statement_to_sql_real:
* @stmt: a #GdaStatement object
* @context: a #GdaSqlRenderingContext context
* @error: a place to store errors, or %NULL
@@ -702,12 +702,12 @@ default_render_value (const GValue *value, GdaSqlRenderingContext *context, GErr
}
/**
- * gda_statement_to_sql_extended
+ * gda_statement_to_sql_extended:
* @stmt: a #GdaStatement object
* @cnc: a #GdaConnection object, or %NULL
* @params: parameters contained in a single #GdaSet object
* @flags: a set of flags to control the rendering
- * @params_used: a place to store the list of actual #GdaHolder objects in @params used to do the rendering, or %NULL
+ * @params_used: (element-type GdaHolder) (out) (transfer container) (allow-none):a place to store the list of actual #GdaHolder objects in @params used to do the rendering, or %NULL
* @error: a place to store errors, or %NULL
*
* Renders @stmt as an SQL statement, with some control on how it is rendered.
diff --git a/libgda/sql-parser/gda-sql-parser.c b/libgda/sql-parser/gda-sql-parser.c
index 7730380..e0fabd5 100644
--- a/libgda/sql-parser/gda-sql-parser.c
+++ b/libgda/sql-parser/gda-sql-parser.c
@@ -1,6 +1,6 @@
/* gda-sql-parser.c
*
- * Copyright (C) 2007 Vivien Malerba
+ * Copyright (C) 2007 - 2010 Vivien Malerba
*
* This Library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public License as
@@ -261,7 +261,7 @@ gda_sql_parser_init (GdaSqlParser *parser)
}
/**
- * gda_sql_parser_new
+ * gda_sql_parser_new:
*
* Creates a new #GdaSqlParser object
*
@@ -415,10 +415,10 @@ gda_sql_parser_get_property (GObject *object,
}
/**
- * gda_sql_parser_parse_string
+ * gda_sql_parser_parse_string:
* @parser: a #GdaSqlParser object
* @sql: the SQL string to parse
- * @remain: location to store a pointer to remaining part of @sql in case @sql has multiple statement, or %NULL
+ * @remain: (out) (allow-none): location to store a pointer to remaining part of @sql in case @sql has multiple statement, or %NULL
* @error: location to store error, or %NULL
*
* Parses @sql and creates a #GdaStatement statement from the first SQL statement contained in @sql: if @sql
@@ -647,10 +647,10 @@ gda_sql_parser_parse_string (GdaSqlParser *parser, const gchar *sql, const gchar
}
/**
- * gda_sql_parser_parse_string_as_batch
+ * gda_sql_parser_parse_string_as_batch:
* @parser: a #GdaSqlParser object
* @sql: the SQL string to parse
- * @remain: location to store a pointer to remaining part of @sql in case an error occurred while parsing @sql, or %NULL
+ * @remain: (out) (allow-none): location to store a pointer to remaining part of @sql in case an error occurred while parsing @sql, or %NULL
* @error: location to store error, or %NULL
*
* Parse @sql and creates a #GdaBatch object which contains all the #GdaStatement objects created while parsing (one object
@@ -738,7 +738,7 @@ gda_sql_parser_parse_string_as_batch (GdaSqlParser *parser, const gchar *sql, co
}
/**
- * gda_sql_parser_parse_file_as_batch
+ * gda_sql_parser_parse_file_as_batch:
* @parser: a #GdaSqlParser object
* @filename: name of the file to parse
* @error: location to store error, or %NULL
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
