[libgda/LIBGDA_4.2] GObject instrospection annotations improvements (many thanks to Daniel Espinosa)
- From: Vivien Malerba <vivien src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgda/LIBGDA_4.2] GObject instrospection annotations improvements (many thanks to Daniel Espinosa)
- Date: Wed, 31 Aug 2011 20:02:49 +0000 (UTC)
commit b35e9d1203bcffce82337028944f8c31163955b3
Author: Vivien Malerba <malerba gnome-db org>
Date: Wed Aug 31 18:51:19 2011 +0200
GObject instrospection annotations improvements (many thanks to Daniel Espinosa)
control-center/gdaui-dsn-editor.c | 2 +-
control-center/gdaui-login-dialog.c | 4 +-
libgda-report/RML/gda-report-rml-document.c | 2 +-
.../gdaui-data-cell-renderer-textual.c | 2 +-
libgda-ui/data-entries/gdaui-entry-combo.c | 2 +-
libgda-ui/data-entries/gdaui-entry.c | 2 +-
libgda-ui/data-entries/gdaui-formatted-entry.c | 2 +-
.../plugins/gdaui-data-cell-renderer-password.c | 2 +-
libgda-ui/gdaui-cloud.c | 2 +-
libgda-ui/gdaui-combo.c | 6 ++--
libgda-ui/gdaui-init.c | 4 +-
libgda-ui/gdaui-login.c | 4 +-
libgda-ui/gdaui-plugin.h | 16 +++++-----
libgda-ui/gdaui-raw-form.c | 2 +-
libgda-ui/gdaui-rt-editor.c | 2 +-
libgda-ui/gdaui-server-operation.c | 6 ++--
libgda/gda-attributes-manager.c | 6 ++--
libgda/gda-column.c | 4 +-
libgda/gda-column.h | 2 +-
libgda/gda-data-handler.c | 8 ++--
libgda/gda-data-model-bdb.c | 2 +-
libgda/gda-data-model.c | 31 +++++++++---------
libgda/gda-data-proxy.c | 2 +-
libgda/gda-holder.c | 2 +-
libgda/gda-holder.h | 2 +-
libgda/gda-meta-store.c | 2 +-
libgda/gda-meta-struct.h | 4 +-
libgda/gda-server-operation.c | 26 ++++++++--------
libgda/gda-sql-builder.c | 12 +++---
libgda/gda-statement-extra.h | 14 ++++++++
libgda/gda-tree-manager.c | 4 +-
libgda/gda-tree-node.c | 6 ++--
libgda/gda-tree.c | 14 +++++---
libgda/gda-util.c | 10 +++---
libgda/gda-value.c | 4 +-
libgda/gda-value.h | 2 +-
libgda/gda-xa-transaction.c | 4 +-
libgda/sql-parser/gda-statement-struct-parts.h | 33 +++++++++++++++----
libgda/sql-parser/gda-statement-struct-select.c | 2 +-
libgda/sql-parser/gda-statement-struct.c | 6 ++--
libgda/sqlite/virtual/gda-ldap-connection.h | 4 +-
libgda/sqlite/virtual/gda-vconnection-data-model.c | 2 +-
libgda/sqlite/virtual/gda-vconnection-data-model.h | 12 +++---
libgda/sqlite/virtual/gda-vconnection-hub.c | 4 +-
libgda/thread-wrapper/gda-thread-wrapper.c | 26 ++++++++--------
tests/gda-ddl-creator.c | 2 +-
tools/browser/browser-connections-list.c | 2 +-
tools/browser/browser-favorites.c | 6 ++--
tools/browser/browser-window.c | 6 ++--
tools/browser/canvas/browser-canvas-column.c | 4 +-
tools/browser/canvas/browser-canvas-db-relations.c | 6 ++--
tools/browser/canvas/browser-canvas-item.c | 4 +-
tools/browser/common/fk-declare.c | 4 +-
tools/browser/common/ui-formgrid.c | 4 +-
tools/browser/data-manager/data-source-editor.c | 2 +-
tools/browser/data-manager/data-source-manager.c | 2 +-
tools/browser/data-manager/data-source.c | 4 +-
tools/browser/query-exec/query-editor.c | 6 ++--
tools/browser/support.c | 2 +-
tools/gda-tree-mgr-xml.c | 2 +-
tools/web-server.c | 2 +-
61 files changed, 203 insertions(+), 165 deletions(-)
---
diff --git a/control-center/gdaui-dsn-editor.c b/control-center/gdaui-dsn-editor.c
index 8ac3e69..267aaff 100644
--- a/control-center/gdaui-dsn-editor.c
+++ b/control-center/gdaui-dsn-editor.c
@@ -326,7 +326,7 @@ gdaui_dsn_editor_get_dsn (GdauiDsnEditor *config)
/**
* gdaui_dsn_editor_set_dsn
* @editor: a #GdauiDsnEditor widget
- * @dsn_info: a #GdaDsnInfo pointer or %NULL
+ * @dsn_info: (allow-none): a #GdaDsnInfo pointer or %NULL
*
*
* Requests that @editor update its contents with @dsn_info's contents
diff --git a/control-center/gdaui-login-dialog.c b/control-center/gdaui-login-dialog.c
index b3123f7..7c65777 100644
--- a/control-center/gdaui-login-dialog.c
+++ b/control-center/gdaui-login-dialog.c
@@ -241,8 +241,8 @@ gdaui_login_dialog_get_type (void)
/**
* gdaui_login_dialog_new
- * @title: title of the dialog, or %NULL
- * @parent: transient parent of the dialog, or %NULL
+ * @title: (allow-none): title of the dialog, or %NULL
+ * @parent: (allow-none): transient parent of the dialog, or %NULL
*
* Creates a new login dialog widget.
*
diff --git a/libgda-report/RML/gda-report-rml-document.c b/libgda-report/RML/gda-report-rml-document.c
index d390a07..4fbda85 100644
--- a/libgda-report/RML/gda-report-rml-document.c
+++ b/libgda-report/RML/gda-report-rml-document.c
@@ -168,7 +168,7 @@ gda_report_rml_document_get_property (GObject *object,
/**
* gda_report_rml_document_new
- * @engine: a #GdaReportEngine, or %NULL
+ * @engine: (allow-none): a #GdaReportEngine, or %NULL
*
* Creates a new #GdaReportRmlDocument using @engine if specified
*
diff --git a/libgda-ui/data-entries/gdaui-data-cell-renderer-textual.c b/libgda-ui/data-entries/gdaui-data-cell-renderer-textual.c
index 7999b33..35be6ad 100644
--- a/libgda-ui/data-entries/gdaui-data-cell-renderer-textual.c
+++ b/libgda-ui/data-entries/gdaui-data-cell-renderer-textual.c
@@ -572,7 +572,7 @@ gdaui_data_cell_renderer_textual_set_property (GObject *object,
/**
* gdaui_data_cell_renderer_textual_new:
- * @dh: a #GdaDataHandler object, or %NULL
+ * @dh: (allow-none): a #GdaDataHandler object, or %NULL
* @type: the #GType being edited
* @options: options as a string
*
diff --git a/libgda-ui/data-entries/gdaui-entry-combo.c b/libgda-ui/data-entries/gdaui-entry-combo.c
index a00c4e8..ba67a64 100644
--- a/libgda-ui/data-entries/gdaui-entry-combo.c
+++ b/libgda-ui/data-entries/gdaui-entry-combo.c
@@ -457,7 +457,7 @@ combo_contents_changed_cb (G_GNUC_UNUSED GdauiCombo *entry, GdauiEntryCombo *com
/**
* gdaui_entry_combo_set_values:
* @combo: a #GdauiEntryCombo widet
- * @values: (element-type GValue): a list of #GValue values, or %NULL
+ * @values: (element-type GValue) (allow-none): a list of #GValue values, or %NULL
*
* Sets the values of @combo to the specified ones. None of the
* values provided in the list is modified.
diff --git a/libgda-ui/data-entries/gdaui-entry.c b/libgda-ui/data-entries/gdaui-entry.c
index 4c9196d..2a1fda6 100644
--- a/libgda-ui/data-entries/gdaui-entry.c
+++ b/libgda-ui/data-entries/gdaui-entry.c
@@ -414,7 +414,7 @@ gdaui_entry_get_text (GdauiEntry *entry)
/**
* gdaui_entry_set_text:
* @entry: a #GdauiEntry widget
- * @text: the text to set into @entry, or %NULL
+ * @text: (allow-none): the text to set into @entry, or %NULL
*
* Sets @text into @entry.
*
diff --git a/libgda-ui/data-entries/gdaui-formatted-entry.c b/libgda-ui/data-entries/gdaui-formatted-entry.c
index 7adb9e8..ace3305 100644
--- a/libgda-ui/data-entries/gdaui-formatted-entry.c
+++ b/libgda-ui/data-entries/gdaui-formatted-entry.c
@@ -428,7 +428,7 @@ gdaui_formatted_entry_assume_delete (GdauiEntry *entry, gint virt_start_pos, gin
/**
* gdaui_formatted_entry_new:
* @format: a format string
- * @mask: a mask string, or %NULL
+ * @mask: (allow-none): a mask string, or %NULL
*
* Creates a new #GdauiFormattedEntry widget.
*
diff --git a/libgda-ui/data-entries/plugins/gdaui-data-cell-renderer-password.c b/libgda-ui/data-entries/plugins/gdaui-data-cell-renderer-password.c
index f198119..ad162a3 100644
--- a/libgda-ui/data-entries/plugins/gdaui-data-cell-renderer-password.c
+++ b/libgda-ui/data-entries/plugins/gdaui-data-cell-renderer-password.c
@@ -337,7 +337,7 @@ gdaui_data_cell_renderer_password_set_property (GObject *object,
/**
* gdaui_data_cell_renderer_password_new
- * @dh: a #GdaDataHandler object, or %NULL
+ * @dh: (allow-none): a #GdaDataHandler object, or %NULL
* @type: the #GType being edited
*
* Creates a new #GdauiDataCellRendererPassword.
diff --git a/libgda-ui/gdaui-cloud.c b/libgda-ui/gdaui-cloud.c
index 9559bcb..937f7e4 100644
--- a/libgda-ui/gdaui-cloud.c
+++ b/libgda-ui/gdaui-cloud.c
@@ -1088,7 +1088,7 @@ gdaui_cloud_create_filter_widget (GdauiCloud *cloud)
* gdaui_cloud_set_weight_func:
* @cloud: a #GdauiCloud widget
* @func: (allow-none): a #GdauiCloudWeightFunc function which computes weights, or %NULL to unset
- * @data: (allow-none): a pointer to pass as last argument of @func each time it is called
+ * @data: (allow-none): a pointer to pass as last argument of @func each time it is called, or %NULL
*
* Specifies a function called by @cloud to compute each row's respective weight.
*
diff --git a/libgda-ui/gdaui-combo.c b/libgda-ui/gdaui-combo.c
index a1ad399..4965042 100644
--- a/libgda-ui/gdaui-combo.c
+++ b/libgda-ui/gdaui-combo.c
@@ -543,8 +543,8 @@ _gdaui_combo_get_selected (GdauiCombo *combo)
/*
* _gdaui_combo_set_selected_ext
* @combo: a #GdauiCombo widget
- * @values: a list of #GValue objects
- * @cols_index: array of gint, index of column to which each value in @values corresponds, or %NULL
+ * @values: (element-type GObject.Value): a list of #GValue objects
+ * @cols_index: (allow-none) (array): array of gint, index of column to which each value in @values corresponds, or %NULL
*
* Sets the currently selected row of @combo from the values stored in @values, assuming that
* these values correspond to the columns listed in @cols_index. @cols_index must contain at least as
@@ -578,7 +578,7 @@ _gdaui_combo_set_selected_ext (GdauiCombo *combo, const GSList *values, gint *co
* _gdaui_combo_get_selected_ext
* @combo: a #GdauiCombo widget
* @n_cols: the number of columns for which values are requested
- * @cols_index: an array of @n_cols #gint indicating which column to get a value for, or %NULL
+ * @cols_index: (array) (allow-none) (array length=n_cols): an array of @n_cols #gint indicating which column to get a value for, or %NULL
*
* Get a list of the currently selected values in @combo. The list itself must be free'd using g_slist_free(),
* but not the values it contains. If there is no selected value in @combo, then %NULL is returned.
diff --git a/libgda-ui/gdaui-init.c b/libgda-ui/gdaui-init.c
index b2d5ef3..cb372cd 100644
--- a/libgda-ui/gdaui-init.c
+++ b/libgda-ui/gdaui-init.c
@@ -91,7 +91,7 @@ gdaui_init (void)
/**
* gdaui_new_data_entry:
* @type: a #GType
- * @plugin_name: the name of an entry plugin, or %NULL
+ * @plugin_name: (allow-none): the name of an entry plugin, or %NULL
*
* Creates a new #GdauiDataEntry widget, taking into account the requested entry name
* if @plugin_name is not %NULL (if no entry of that name is found, then the default data
@@ -191,7 +191,7 @@ gdaui_new_data_entry (GType type, const gchar *plugin_name)
/*
* _gdaui_new_cell_renderer
* @type: a #GType
- * @plugin_name: the name of an entry plugin, or %NULL
+ * @plugin_name: (allow-none): the name of an entry plugin, or %NULL
*
* Creates a new #GtkCellRenderer object which is suitable to use in
* a #GtkTreeView widget, taking into account the requested entry name
diff --git a/libgda-ui/gdaui-login.c b/libgda-ui/gdaui-login.c
index 5896882..322388d 100644
--- a/libgda-ui/gdaui-login.c
+++ b/libgda-ui/gdaui-login.c
@@ -489,7 +489,7 @@ cnc_params_editor_changed_cb (G_GNUC_UNUSED GdauiProviderSpecEditor *editor, Gda
/**
* gdaui_login_new:
- * @dsn: a data source name, or %NULL
+ * @dsn: (allow-none): a data source name, or %NULL
*
* Creates a new login widget which enables the user to specify connection parameters.
*
@@ -612,7 +612,7 @@ gdaui_login_get_connection_information (GdauiLogin *login)
/**
* gdaui_login_set_dsn:
* @login: a #GdauiLogin object
- * @dsn: a data source name, or %NULL
+ * @dsn: (allow-none): a data source name, or %NULL
*
* Changes the information displayed in @login, to represent @dsn.
* If @login's mode has %GDA_UI_LOGIN_HIDE_DSN_SELECTION_MODE, then
diff --git a/libgda-ui/gdaui-plugin.h b/libgda-ui/gdaui-plugin.h
index 33ac767..6b526a8 100644
--- a/libgda-ui/gdaui-plugin.h
+++ b/libgda-ui/gdaui-plugin.h
@@ -29,7 +29,7 @@
* GdauiEntryCreateFunc:
* @Param1: a #GdaDataHandler
* @Param2: a #GType
- * @Param3: options, or %NULL
+ * @Param3: (allow-none): options, or %NULL
* @Returns: a new #GdauiDataEntry
*
* Defines a function which creates a #GdauiDataEntry widget
@@ -40,7 +40,7 @@ typedef GdauiDataEntry *(*GdauiEntryCreateFunc)(GdaDataHandler *, GType, const
* GdauiCellCreateFunc:
* @Param1: a #GdaDataHandler
* @Param2: a #GType
- * @Param3: options, or %NULL
+ * @Param3: (allow-none): options, or %NULL
* @Returns:a new #GtkCellRenderer
*
* Defines a function which creates a #GtkCellRenderer object
@@ -51,13 +51,13 @@ typedef GtkCellRenderer *(*GdauiCellCreateFunc) (GdaDataHandler *, GType, const
/**
* GdauiPlugin:
* @plugin_name: the name of the plugin
- * @plugin_descr: a description for the plugin, or %NULL
- * @plugin_file: the shared object implementing the plugin, can be %NULL for internal plugins
+ * @plugin_descr: (allow-none): a description for the plugin, or %NULL
+ * @plugin_file: (allow-none): the shared object implementing the plugin, can be %NULL for internal plugins
* @nb_g_types: number of types the plugin can handle, or %0 for any type
- * @valid_g_types: an array of #GType, containing the accepted types, its size is @nb_g_types, or %NULL if @nb_g_types is %0
- * @options_xml_spec: a string describing the plugin's options, or %NULL
- * @entry_create_func: the function called to create a #GdauiDataEntry, or %NULL
- * @cell_create_func: the function called to create a #GtkCellRenderer, or %NULL
+ * @valid_g_types: (allow-none): an array of #GType, containing the accepted types, its size is @nb_g_types, or %NULL if @nb_g_types is %0
+ * @options_xml_spec: (allow-none): a string describing the plugin's options, or %NULL
+ * @entry_create_func: (allow-none): the function called to create a #GdauiDataEntry, or %NULL
+ * @cell_create_func: (allow-none): the function called to create a #GtkCellRenderer, or %NULL
*
* Structure representing a plugin.
*
diff --git a/libgda-ui/gdaui-raw-form.c b/libgda-ui/gdaui-raw-form.c
index 72aecc3..4b9510a 100644
--- a/libgda-ui/gdaui-raw-form.c
+++ b/libgda-ui/gdaui-raw-form.c
@@ -296,7 +296,7 @@ gdaui_raw_form_init (GdauiRawForm *wid)
/**
* gdaui_raw_form_new:
- * @model: a #GdaDataModel, or %NULL
+ * @model: (allow-none): a #GdaDataModel, or %NULL
*
* Creates a new #GdauiRawForm widget to display data in @model
*
diff --git a/libgda-ui/gdaui-rt-editor.c b/libgda-ui/gdaui-rt-editor.c
index 0779edb..9185fcc 100644
--- a/libgda-ui/gdaui-rt-editor.c
+++ b/libgda-ui/gdaui-rt-editor.c
@@ -1250,7 +1250,7 @@ spaces_since_start_of_line (GtkTextIter *iter)
* get_markup_token
* @iter: starting position
* @out_nb_spaces_before: a place to set the value returned by spaces_since_start_of_line() if called
- * @out_end: place to put the last used position, or %NULL
+ * @out_end: (allow-none): place to put the last used position, or %NULL
* @rte: the #GdauiRtEditor
*
* Parses marking tokens, nothing else
diff --git a/libgda-ui/gdaui-server-operation.c b/libgda-ui/gdaui-server-operation.c
index 1099ce7..b9ffdc5 100644
--- a/libgda-ui/gdaui-server-operation.c
+++ b/libgda-ui/gdaui-server-operation.c
@@ -1083,9 +1083,9 @@ sequence_item_remove_cb (GdaServerOperation *op, const gchar *seq_path, gint ite
/**
* gdaui_server_operation_new_in_dialog
* @op: a #GdaServerOperation object
- * @parent: the parent window for the new dialog, or %NULL
- * @title: the title of the dialog window, or %NULL
- * @header: a helper text displayed at the top of the dialog, or %NULL
+ * @parent: (allow-none): the parent window for the new dialog, or %NULL
+ * @title: (allow-none): the title of the dialog window, or %NULL
+ * @header: (allow-none): a helper text displayed at the top of the dialog, or %NULL
*
* Creates a new #GdauiServerOperation widget in the same way as gdaui_server_operation_new()
* and puts it into a #GtkDialog widget. The returned dialog has the "Ok" and "Cancel" buttons
diff --git a/libgda/gda-attributes-manager.c b/libgda/gda-attributes-manager.c
index e7b65b7..fa82328 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: (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_func: (allow-none): 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
*
* Creates a new #GdaAttributesManager, which can store (name, value) attributes for pointers or GObject objects
@@ -249,7 +249,7 @@ manager_real_set (GdaAttributesManager *mgr, gpointer ptr,
* @mgr: a #GdaAttributesManager
* @ptr: a pointer to the resources to which the attribute will apply
* @att_name: an attribute's name
- * @value: (transfer none): a #GValue, or %NULL
+ * @value: (transfer none) (allow-none): a #GValue, or %NULL
*
* Associates an attribute named @att_name to @ptr, with the value @value. Any previous association is replaced by
* this one, and if @value is %NULL then the association is removed.
@@ -271,7 +271,7 @@ gda_attributes_manager_set (GdaAttributesManager *mgr, gpointer ptr, const gchar
* @mgr: a #GdaAttributesManager
* @ptr: a pointer to the resources to which the attribute will apply
* @att_name: an attribute's name
- * @value: a #GValue, or %NULL
+ * @value: (allow-none): a #GValue, or %NULL
* @destroy: function called when @att_name has to be freed
*
* Does the same as gda_attributes_manager_set() except that @destroy is called when @att_name needs
diff --git a/libgda/gda-column.c b/libgda/gda-column.c
index e970318..51833f2 100644
--- a/libgda/gda-column.c
+++ b/libgda/gda-column.c
@@ -596,8 +596,8 @@ gda_column_get_attribute (GdaColumn *column, const gchar *attribute)
* gda_column_set_attribute:
* @column: a #GdaColumn
* @attribute: attribute name as a static string
- * @value: a #GValue, or %NULL
- * @destroy: a function to be called when @attribute is not needed anymore, or %NULL
+ * @value: (allow-none): a #GValue, or %NULL
+ * @destroy: (allow-none): a function to be called when @attribute is not needed anymore, or %NULL
*
* Set the value associated to a named attribute. The @attribute string is 'stolen' by this method, and
* the memory it uses will be freed using the @destroy function when no longer needed (if @destroy is %NULL,
diff --git a/libgda/gda-column.h b/libgda/gda-column.h
index 26ca42a..376de71 100644
--- a/libgda/gda-column.h
+++ b/libgda/gda-column.h
@@ -90,7 +90,7 @@ void gda_column_set_attribute (GdaColumn *column, const gchar *a
* gda_column_set_attribute_static
* @holder: a #GdaHolder
* @attribute: attribute's name
- * @value: the value to set the attribute to, or %NULL
+ * @value: (allow-none): the value to set the attribute to, or %NULL
*
* This function is similar to gda_column_set_attribute() but for static strings
*/
diff --git a/libgda/gda-data-handler.c b/libgda/gda-data-handler.c
index c5aa71a..554734b 100644
--- a/libgda/gda-data-handler.c
+++ b/libgda/gda-data-handler.c
@@ -76,7 +76,7 @@ gda_data_handler_iface_init (G_GNUC_UNUSED gpointer g_class)
/**
* gda_data_handler_get_sql_from_value:
* @dh: an object which implements the #GdaDataHandler interface
- * @value: the value to be converted to a string
+ * @value: (allow-none): the value to be converted to a string, or %NULL
*
* Creates a new string which is an SQL representation of the given value, the returned string
* can be used directly in an SQL statement. For example if @value is a G_TYPE_STRING, then
@@ -107,7 +107,7 @@ gda_data_handler_get_sql_from_value (GdaDataHandler *dh, const GValue *value)
/**
* gda_data_handler_get_str_from_value:
* @dh: an object which implements the #GdaDataHandler interface
- * @value: the value to be converted to a string
+ * @value: (allow-none): the value to be converted to a string, or %NULL
*
* Creates a new string which is a "user friendly" representation of the given value
* (in the user's locale, specially for the dates). If the value is
@@ -133,7 +133,7 @@ gda_data_handler_get_str_from_value (GdaDataHandler *dh, const GValue *value)
/**
* gda_data_handler_get_value_from_sql:
* @dh: an object which implements the #GdaDataHandler interface
- * @sql: an SQL string
+ * @sql: (allow-none): an SQL string, or %NULL
* @type: a GType
*
* Creates a new GValue which represents the SQL value given as argument. This is
@@ -165,7 +165,7 @@ gda_data_handler_get_value_from_sql (GdaDataHandler *dh, const gchar *sql, GType
/**
* gda_data_handler_get_value_from_str:
* @dh: an object which implements the #GdaDataHandler interface
- * @str: a string
+ * @str: (allow-none): a string or %NULL
* @type: a GType
*
* Creates a new GValue which represents the @str value given as argument. This is
diff --git a/libgda/gda-data-model-bdb.c b/libgda/gda-data-model-bdb.c
index 79af8b4..22658b4 100644
--- a/libgda/gda-data-model-bdb.c
+++ b/libgda/gda-data-model-bdb.c
@@ -463,7 +463,7 @@ gda_data_model_bdb_get_property (GObject *object,
/**
* gda_data_model_bdb_new:
* @filename: name of the file containing the database
- * @db_name: the name of the database within @filename, or %NULL
+ * @db_name: (allow-none): the name of the database within @filename, or %NULL
*
* Creates a new #GdaDataModel object to access the contents of the Berkeley DB file @file,
* for the database @db_name if not %NULL
diff --git a/libgda/gda-data-model.c b/libgda/gda-data-model.c
index dbea330..7c13940 100644
--- a/libgda/gda-data-model.c
+++ b/libgda/gda-data-model.c
@@ -772,7 +772,7 @@ gda_data_model_set_value_at (GdaDataModel *model, gint col, gint row, const GVal
* gda_data_model_set_values:
* @model: a #GdaDataModel object.
* @row: row number.
- * @values: (element-type GObject.Value) (transfer none): a list of #GValue, one for at most the number of columns of @model
+ * @values: (element-type GObject.Value) (transfer none) (allow-none): a list of #GValue (or %NULL), 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
@@ -784,12 +784,13 @@ gda_data_model_set_value_at (GdaDataModel *model, gint col, gint row, const GVal
* Upon errors FALSE will be returned and @error will be assigned a
* #GError from the #GDA_DATA_MODEL_ERROR domain.
*
- * Returns: TRUE if the value in the data model has been updated and no error occurred
+ * Returns: %TRUE if the value in the data model has been updated and no error occurred
*/
gboolean
gda_data_model_set_values (GdaDataModel *model, gint row, GList *values, GError **error)
{
g_return_val_if_fail (GDA_IS_DATA_MODEL (model), FALSE);
+
if (GDA_DATA_MODEL_GET_CLASS (model)->i_set_values)
return (GDA_DATA_MODEL_GET_CLASS (model)->i_set_values) (model, row, values, error);
@@ -866,13 +867,13 @@ gda_data_model_create_iter (GdaDataModel *model)
/**
* gda_data_model_append_values:
* @model: a #GdaDataModel object.
- * @values: (element-type GObject.Value): #GList of #GValue* representing the row to add. The
+ * @values: (element-type GObject.Value) (allow-none): #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
*
* Appends a row to the given data model. If any value in @values is actually %NULL, then
- * it is considered as a default value.
+ * it is considered as a default value. If @values is %NULL then all values are set to their default value.
*
* Upon errors -1 will be returned and @error will be assigned a
* #GError from the #GDA_DATA_MODEL_ERROR domain.
@@ -1039,7 +1040,7 @@ gda_data_model_get_row_from_values (GdaDataModel *model, GSList *values, gint *c
* gda_data_model_send_hint:
* @model: a #GdaDataModel
* @hint: (transfer none): a hint to send to the model
- * @hint_value: an optional value to specify the hint, or %NULL
+ * @hint_value: (allow-none): 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
* model, depending on its implementation
@@ -1087,9 +1088,9 @@ static gchar *export_to_text_separated (GdaDataModel *model, const gint *cols, g
* gda_data_model_export_to_string:
* @model: a #GdaDataModel
* @format: the format in which to export data
- * @cols: (array length=nb_cols): an array containing which columns of @model will be exported, or %NULL for all columns
+ * @cols: (array length=nb_cols) (allow-none): an array containing which columns of @model will be exported, or %NULL for all columns
* @nb_cols: the number of columns in @cols
- * @rows: (array length=nb_rows): an array containing which rows of @model will be exported, or %NULL for all rows
+ * @rows: (array length=nb_rows) (allow-none): 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
*
@@ -1294,9 +1295,9 @@ gda_data_model_export_to_string (GdaDataModel *model, GdaDataModelIOFormat forma
* @model: a #GdaDataModel
* @format: the format in which to export data
* @file: the filename to export to
- * @cols: (array length=nb_cols): an array containing which columns of @model will be exported, or %NULL for all columns
+ * @cols: (array length=nb_cols) (allow-none): an array containing which columns of @model will be exported, or %NULL for all columns
* @nb_cols: the number of columns in @cols
- * @rows: (array length=nb_rows): an array containing which rows of @model will be exported, or %NULL for all rows
+ * @rows: (array length=nb_rows) (allow-none): 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
@@ -1495,11 +1496,11 @@ xml_set_boolean (xmlNodePtr node, const gchar *name, gboolean value)
/*
* gda_data_model_to_xml_node
* @model: a #GdaDataModel object.
- * @cols: an array containing which columns of @model will be exported, or %NULL for all columns
+ * @cols: (allow-none) (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: (allow-none) (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
- * @name: name to use for the XML resulting table.
+ * @name: (allow-none): name to use for the XML resulting table or %NULL.
*
* Converts a #GdaDataModel into a xmlNodePtr (as used in libxml).
*
@@ -1787,7 +1788,7 @@ gda_data_model_add_data_from_xml_node (GdaDataModel *model, xmlNodePtr node, GEr
* @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: (element-type gint gint): a #GHashTable for columns translating, or %NULL
+ * @cols_trans: (element-type gint gint) (allow-none): 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
@@ -2053,7 +2054,7 @@ gda_data_model_import_from_model (GdaDataModel *to, GdaDataModel *from,
* gda_data_model_import_from_string:
* @model: a #GdaDataModel
* @string: the string to import data from
- * @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()
+ * @cols_trans: (element-type gint gint) (allow-none): 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
*
@@ -2088,7 +2089,7 @@ gda_data_model_import_from_string (GdaDataModel *model,
* gda_data_model_import_from_file:
* @model: a #GdaDataModel
* @file: the filename to import from
- * @cols_trans: (element-type gint gint): a #GHashTable for columns translating, or %NULL, see gda_data_model_import_from_model()
+ * @cols_trans: (element-type gint gint) (allow-none): 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
*
diff --git a/libgda/gda-data-proxy.c b/libgda/gda-data-proxy.c
index ca03ea2..fed8e67 100644
--- a/libgda/gda-data-proxy.c
+++ b/libgda/gda-data-proxy.c
@@ -3087,7 +3087,7 @@ apply_filter_statement (GdaDataProxy *proxy, GError **error)
/**
* gda_data_proxy_set_filter_expr:
* @proxy: a #GdaDataProxy object
- * @filter_expr: an SQL based expression which will filter the contents of @proxy, or %NULL to remove any previous filter
+ * @filter_expr: (allow-none): an SQL based expression which will filter the contents of @proxy, or %NULL to remove any previous filter
* @error: a place to store errors, or %NULL
*
* Sets a filter among the rows presented by @proxy. The filter is defined by a filter expression
diff --git a/libgda/gda-holder.c b/libgda/gda-holder.c
index e15ce21..59e25a6 100644
--- a/libgda/gda-holder.c
+++ b/libgda/gda-holder.c
@@ -407,7 +407,7 @@ gda_holder_copy (GdaHolder *orig)
/**
* gda_holder_new_inline: (skip)
* @type: a valid GLib type
- * @id: the id of the holder to create, or %NULL
+ * @id: (allow-none): the id of the holder to create, or %NULL
* @...: value to set
*
* Creates a new #GdaHolder object with an ID set to @id, of type @type,
diff --git a/libgda/gda-holder.h b/libgda/gda-holder.h
index 5169353..ef55d84 100644
--- a/libgda/gda-holder.h
+++ b/libgda/gda-holder.h
@@ -145,7 +145,7 @@ void gda_holder_set_attribute (GdaHolder *holder, cons
* gda_holder_set_attribute_static
* @holder: a #GdaHolder
* @attribute: attribute's name
- * @value: a #GValue, or %NULL
+ * @value: (allow-none): a #GValue, or %NULL
*
* This function is similar to gda_holder_set_attribute() but for static strings
*/
diff --git a/libgda/gda-meta-store.c b/libgda/gda-meta-store.c
index 04c181e..1f7e692 100644
--- a/libgda/gda-meta-store.c
+++ b/libgda/gda-meta-store.c
@@ -643,7 +643,7 @@ gda_meta_store_new_with_file (const gchar *file_name)
/**
* gda_meta_store_new:
- * @cnc_string: a connection string, or %NULL for an in-memory internal database
+ * @cnc_string: (allow-none): a connection string, or %NULL for an in-memory internal database
*
* Create a new #GdaMetaStore object.
*
diff --git a/libgda/gda-meta-struct.h b/libgda/gda-meta-struct.h
index 05ed8dc..4d8bdad 100644
--- a/libgda/gda-meta-struct.h
+++ b/libgda/gda-meta-struct.h
@@ -242,7 +242,7 @@ typedef struct {
* @gtype: the detected column's #GType
* @pkey: tells if the column is part of a primary key
* @nullok: tells if the column can be %NULL
- * @default_value: the column's default value, represented as a valid SQL value (surrounded by simple quotes for strings, ...), or %NULL if column has no default value
+ * @default_value: (allow-none): the column's default value, represented as a valid SQL value (surrounded by simple quotes for strings, ...), or %NULL if column has no default value
*
* This structure represents a table of view's column, its contents must not be modified.
*/
@@ -280,7 +280,7 @@ void gda_meta_table_column_set_attribute (GdaMetaTableColumn *tcol, con
* gda_meta_table_column_set_attribute_static
* @column: a #GdaMetaTableColumn
* @attribute: attribute's name
- * @value: a #GValue, or %NULL
+ * @value: (allow-none): a #GValue, or %NULL
*
* This function is similar to gda_meta_table_column_set_attribute() but for static strings
*/
diff --git a/libgda/gda-server-operation.c b/libgda/gda-server-operation.c
index 5970e4e..41685ac 100644
--- a/libgda/gda-server-operation.c
+++ b/libgda/gda-server-operation.c
@@ -2085,8 +2085,8 @@ gda_server_operation_get_value_at (GdaServerOperation *op, const gchar *path_for
/**
* gda_server_operation_get_sql_identifier_at: (skip)
* @op: a #GdaServerOperation object
- * @cnc: a #GdaConnection, or %NULL
- * @prov: a #GdaServerProvider, or %NULL
+ * @cnc: (allow-none): a #GdaConnection, or %NULL
+ * @prov: (allow-none): a #GdaServerProvider, or %NULL
* @path_format: a complete path to a node (starting with "/")
* @...: arguments to use with @path_format to make a complete path
*
@@ -2124,8 +2124,8 @@ gda_server_operation_get_sql_identifier_at (GdaServerOperation *op, GdaConnectio
/**
* gda_server_operation_get_sql_identifier_at_path:
* @op: a #GdaServerOperation object
- * @cnc: a #GdaConnection, or %NULL
- * @prov: a #GdaServerProvider, or %NULL
+ * @cnc: (allow-none): a #GdaConnection, or %NULL
+ * @prov: (allow-none): a #GdaServerProvider, or %NULL
* @path: a complete path to a node (starting with "/")
*
* This method is similar to gda_server_operation_get_value_at(), but for SQL identifiers: a new string
@@ -2165,9 +2165,9 @@ gda_server_operation_get_sql_identifier_at_path (GdaServerOperation *op, GdaConn
/**
* gda_server_operation_set_value_at_path:
* @op: a #GdaServerOperation object
- * @value: a string
- * @error: a place to store errors or %NULL
+ * @value: (allow-none): a string
* @path: a complete path to a node (starting with "/")
+ * @error: a place to store errors or %NULL
*
* Set the value for the node at the path formed using @path_format and the ... ellipse (the rules are the same as
* for g_strdup_printf()).
@@ -2347,7 +2347,7 @@ gda_server_operation_set_value_at_path (GdaServerOperation *op, const gchar *val
/**
* gda_server_operation_set_value_at: (skip)
* @op: a #GdaServerOperation object
- * @value: a string
+ * @value: (allow-none): a string
* @error: a place to store errors or %NULL
* @path_format: a complete path to a node (starting with "/")
* @...: arguments to use with @path_format to make a complete path
@@ -2409,7 +2409,7 @@ gda_server_operation_set_value_at (GdaServerOperation *op, const gchar *value, G
/**
* gda_server_operation_is_valid:
* @op: a #GdaServerOperation widget
- * @xml_file: an XML specification file (see gda_server_operation_new())
+ * @xml_file: (allow-none): an XML specification file (see gda_server_operation_new()) or %NULL
* @error: a place to store an error, or %NULL
*
* Tells if all the required values in @op have been defined.
@@ -2482,7 +2482,7 @@ gda_server_operation_is_valid (GdaServerOperation *op, const gchar *xml_file, GE
/**
* gda_server_operation_prepare_create_database:
* @provider: the database provider to use
- * @db_name: the name of the database to create, or %NULL
+ * @db_name: (allow-none): the name of the database to create, or %NULL
* @error: a place to store errors, or %NULL
*
* Creates a new #GdaServerOperation object which contains the specifications required
@@ -2522,7 +2522,7 @@ gda_server_operation_prepare_create_database (const gchar *provider, const gchar
/**
* gda_server_operation_perform_create_database:
- * @provider: the database provider to use, or %NULL if @op has been created using gda_server_operation_prepare_create_database()
+ * @provider: (allow-none): the database provider to use, or %NULL if @op has been created using gda_server_operation_prepare_create_database()
* @op: a #GdaServerOperation object obtained using gda_server_operation_prepare_create_database()
* @error: a place to store en error, or %NULL
*
@@ -2555,7 +2555,7 @@ gda_server_operation_perform_create_database (GdaServerOperation *op, const gcha
/**
* gda_server_operation_prepare_drop_database:
* @provider: the database provider to use
- * @db_name: the name of the database to drop, or %NULL
+ * @db_name: (allow-none): the name of the database to drop, or %NULL
* @error: a place to store errors, or %NULL
*
* Creates a new #GdaServerOperation object which contains the specifications required
@@ -2595,8 +2595,8 @@ gda_server_operation_prepare_drop_database (const gchar *provider, const gchar *
/**
* gda_server_operation_perform_drop_database:
- * @provider: the database provider to use, or %NULL if @op has been created using gda_server_operation_prepare_drop_database()
- * @op: a #GdaServerOperation object obtained using gda_prepare_drop_database()
+ * @provider: (allow-none): the database provider to use, or %NULL if @op has been created using gda_server_operation_prepare_drop_database()
+ * @op: a #GdaServerOperation object obtained using gda_server_operation_prepare_drop_database()
* @error: a place to store en error, or %NULL
*
* Destroys an existing database using the specifications in @op. @op can be obtained using
diff --git a/libgda/gda-sql-builder.c b/libgda/gda-sql-builder.c
index 9ac38e9..32cc592 100644
--- a/libgda/gda-sql-builder.c
+++ b/libgda/gda-sql-builder.c
@@ -483,8 +483,8 @@ gda_sql_builder_set_where (GdaSqlBuilder *builder, GdaSqlBuilderId cond_id)
* gda_sql_builder_select_add_field:
* @builder: a #GdaSqlBuilder object
* @field_name: a field name
- * @table_name: a table name, or %NULL
- * @alias: an alias (eg. for the "AS" clause), or %NULL
+ * @table_name: (allow-none): a table name, or %NULL
+ * @alias: (allow-none): an alias (eg. for the "AS" clause), or %NULL
*
* Valid only for: SELECT statements.
*
@@ -651,7 +651,7 @@ gda_sql_builder_add_field_value (GdaSqlBuilder *builder, const gchar *field_name
* gda_sql_builder_add_field_value_as_gvalue:
* @builder: a #GdaSqlBuilder object
* @field_name: a field name
- * @value: value to set the field to, or %NULL or a GDA_TYPE_NULL value to represent an SQL NULL
+ * @value: (allow-none): value to set the field to, or %NULL or a GDA_TYPE_NULL value to represent an SQL NULL
*
* Valid only for: INSERT, UPDATE statements.
*
@@ -799,8 +799,8 @@ gda_sql_builder_add_field_value_id (GdaSqlBuilder *builder, GdaSqlBuilderId fiel
/**
* gda_sql_builder_add_expr_value:
* @builder: a #GdaSqlBuilder object
- * @dh: a #GdaDataHandler to use, or %NULL
- * @value: value to set the expression to, or %NULL or a GDA_TYPE_NULL value to represent an SQL NULL
+ * @dh: (allow-none): a #GdaDataHandler to use, or %NULL
+ * @value: (allow-none): value to set the expression to, or %NULL or a GDA_TYPE_NULL value to represent an SQL NULL
*
* Defines an expression in @builder which may be reused to build other parts of a statement.
*
@@ -855,7 +855,7 @@ gda_sql_builder_add_expr_value (GdaSqlBuilder *builder, GdaDataHandler *dh, cons
/**
* gda_sql_builder_add_expr: (skip)
* @builder: a #GdaSqlBuilder object
- * @dh: a #GdaDataHandler to use, or %NULL
+ * @dh: (allow-none): a #GdaDataHandler to use, or %NULL
* @type: the GType of the following argument
* @...: value to set the expression to, of the type specified by @type
*
diff --git a/libgda/gda-statement-extra.h b/libgda/gda-statement-extra.h
index ac2a193..9a83321 100644
--- a/libgda/gda-statement-extra.h
+++ b/libgda/gda-statement-extra.h
@@ -33,6 +33,20 @@ typedef gchar *(*GdaSqlRenderingFunc) (GdaSqlAnyPart *node, GdaSqlRendering
typedef gchar *(*GdaSqlRenderingExpr) (GdaSqlExpr *expr, GdaSqlRenderingContext *context,
gboolean *is_default, gboolean *is_null,
GError **error);
+
+/**
+ * GdaSqlRenderingPSpecFunc:
+ * @pspec: #GdaSqlParamSpec to render
+ * @expr: (allow-none): #GdaSqlExpr which may hold the default value for the parameter, or %NULL
+ * @context: the rendering context
+ * @is_default: pointer to a #gboolean which is set to TRUE if value should be considered as a default value
+ * @is_null: pointer to a #gboolean which is set to TRUE if value should be considered as NULL
+ * @error: a place to store errors, or %NULL
+ * @Returns: a new string, or %NULL if an error occurred
+ *
+ * Rendering function type to render a #GdaSqlParamSpec
+ */
+
typedef gchar *(*GdaSqlRenderingPSpecFunc) (GdaSqlParamSpec *pspec, GdaSqlExpr *expr, GdaSqlRenderingContext *context,
gboolean *is_default, gboolean *is_null,
GError **error);
diff --git a/libgda/gda-tree-manager.c b/libgda/gda-tree-manager.c
index e40fdb4..dd6afb1 100644
--- a/libgda/gda-tree-manager.c
+++ b/libgda/gda-tree-manager.c
@@ -248,10 +248,10 @@ gda_tree_manager_get_property (GObject *object,
/*
* @manager: a #GdaTreeManager object
- * @node: a #GdaTreeNode object, or %NULL
+ * @node: (allow-none): a #GdaTreeNode object, or %NULL
* @children_nodes: a list of #GdaTreeNode nodes which have previously been created by a similar call and
* need to be updated ore moved
- * @out_error: a boolean to store if there was an error (can be %NULL)
+ * @out_error: (allow-none): a boolean to store if there was an error (can be %NULL)
* @error: a place to store errors, or %NULL
*
* Creates (or updates) the list of #GdaTreeNode objects which are placed as children of @node. The returned
diff --git a/libgda/gda-tree-node.c b/libgda/gda-tree-node.c
index 030a751..29f6365 100644
--- a/libgda/gda-tree-node.c
+++ b/libgda/gda-tree-node.c
@@ -456,7 +456,7 @@ gda_tree_node_dump_children (GdaTreeNode *node, const gchar *prefix, GString *in
/**
* gda_tree_node_new:
- * @name: a name, or %NULL
+ * @name: (allow-none): a name, or %NULL
*
* Creates a new #GdaTreeNode object
*
@@ -474,7 +474,7 @@ gda_tree_node_new (const gchar *name)
* _gda_tree_node_add_children:
* @node: a #GdaTreeNode
* @mgr: a #GdaTreeManager object
- * @childen: a list of #GdaTreeNode objects, or %NULL
+ * @childen: (allow-none): a list of #GdaTreeNode objects, or %NULL
*
* Requests that @node take the list of nodes in @children as its children. The children list
* may be a new list of children, or may be an update of a list of children which previously existed.
@@ -720,7 +720,7 @@ gda_tree_node_get_node_attribute (GdaTreeNode *node, const gchar *attribute)
* gda_tree_node_set_node_attribute:
* @node: a #GdaTreeNode
* @attribute: attribute name
- * @value: (transfer none): a #GValue, or %NULL
+ * @value: (transfer none) (allow-none): a #GValue, or %NULL
* @destroy: a function to be called when @attribute is not needed anymore, or %NULL
*
* Set the value associated to a named attribute. The @attribute string is used AS IT IS by this method (eg.
diff --git a/libgda/gda-tree.c b/libgda/gda-tree.c
index 52f1e4e..afced42 100644
--- a/libgda/gda-tree.c
+++ b/libgda/gda-tree.c
@@ -437,7 +437,7 @@ gda_tree_update_part (GdaTree *tree, GdaTreeNode *node, GError **error)
/**
* gda_tree_update_children:
* @tree: a #GdaTree object
- * @node: (allow-none): a #GdaTreeNode node in @tree
+ * @node: (allow-none): a #GdaTreeNode node in @tree, or %NULL
* @error: (allow-none): a place to store errors, or %NULL
*
* Update the children of @node in @tree (not recursively, to update recursively, use
@@ -481,8 +481,8 @@ gda_tree_update_children (GdaTree *tree, GdaTreeNode *node, GError **error)
/**
* gda_tree_dump:
* @tree: a #GdaTree
- * @node: a #GdaTreeNode to start the dump from, or %NULL for a full dump
- * @stream: a stream to send the dump to, or %NULL for STDOUT
+ * @node: (allow-none): a #GdaTreeNode to start the dump from, or %NULL for a full dump
+ * @stream: (allow-none): a stream to send the dump to, or %NULL for STDOUT
*
* Dumps the contents of @tree to @stream, using a hierarchical view.
*
@@ -513,7 +513,7 @@ static GSList *decompose_path_as_segments (const gchar *path, gboolean use_names
/**
* gda_tree_get_nodes_in_path:
* @tree: a #GdaTree object
- * @tree_path: full path to the required nodes (if @use_names is %TRUE, then it must start with '/')
+ * @tree_path: (allow-none): full path to the required nodes (if @use_names is %TRUE, then it must start with '/'), or %NULL
* @use_names: if %TRUE, then @tree_path will be interpreted as a unix style path, and if %FALSE,
* then @tree_path will be interpreted similarly to the #GtkTreePath's string representation.
*
@@ -748,7 +748,11 @@ create_or_update_children (GSList *mgrlist, GdaTreeNode *parent, gboolean disabl
static GSList *split_absolute_path (const gchar *path, gboolean *out_error);
static GSList *split_indexed_path (const gchar *path, gboolean *out_error);
-/*
+/**
+ * decompose_path_as_segments
+ * @path: a path using '/'
+ * @use_names:
+ *
* Returns: a new list of allocated strings (one for each segment of @path), or %NULL
*/
static GSList *
diff --git a/libgda/gda-util.c b/libgda/gda-util.c
index b68428b..47ed89d 100644
--- a/libgda/gda-util.c
+++ b/libgda/gda-util.c
@@ -384,9 +384,9 @@ gda_utility_check_data_model (GdaDataModel *model, gint nbcols, ...)
* gda_utility_data_model_dump_data_to_xml:
* @model: a #GdaDataModel
* @parent: the parent XML node
- * @cols: an array containing which columns of @model will be exported, or %NULL for all columns
+ * @cols: (allow-none) (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: (allow-none) (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
* @use_col_ids: set to %TRUE to add column ID information
*
@@ -891,7 +891,7 @@ dml_statements_check_select_structure (GdaConnection *cnc, GdaSqlStatement *sel_
/**
* gda_compute_unique_table_row_condition_with_cnc:
- * @cnc: a #GdaConnection, or %NULL
+ * @cnc: (allow-none): a #GdaConnection, or %NULL
* @stsel: a #GdaSqlSelectStatement
* @mtable: a #GdaMetaTable
* @require_pk: set to TRUE if a primary key ir required
@@ -2307,8 +2307,8 @@ static gboolean _sql_identifier_needs_quotes (const gchar *str);
/**
* gda_sql_identifier_quote:
* @id: an SQL identifier
- * @cnc: a #GdaConnection object, or %NULL
- * @prov: a #GdaServerProvider object, or %NULL
+ * @cnc: (allow-none): a #GdaConnection object, or %NULL
+ * @prov: (allow-none): a #GdaServerProvider object, or %NULL
* @for_meta_store set to %TRUE if the returned string will be used in a #GdaMetaStore
* @force_quotes: set to %TRUE to force the returned string to be quoted
*
diff --git a/libgda/gda-value.c b/libgda/gda-value.c
index 8ac570c..6ce9fb2 100644
--- a/libgda/gda-value.c
+++ b/libgda/gda-value.c
@@ -524,7 +524,7 @@ gda_blob_free (gpointer boxed)
/**
* gda_blob_set_op:
* @blob: a #GdaBlob value
- * @op: a #GdaBlobOp object, or %NULL
+ * @op: (allow-none): a #GdaBlobOp object, or %NULL
*
* correctly assigns @op to @blob
*/
@@ -1214,7 +1214,7 @@ gda_value_new (GType type)
/**
* gda_value_new_default:
- * @default_val: the default value as a string, or %NULL
+ * @default_val: (allow-none): the default value as a string, or %NULL
*
* Creates a new default value.
*
diff --git a/libgda/gda-value.h b/libgda/gda-value.h
index 91f4882..f722f2e 100644
--- a/libgda/gda-value.h
+++ b/libgda/gda-value.h
@@ -104,7 +104,7 @@ typedef struct {
/**
* GdaBlob
* @data: data buffer, as a #GdaBinary
- * @op: a pointer to a #GdaBlopOp, or %NULL
+ * @op: (allow-none): a pointer to a #GdaBlopOp, or %NULL
*
* Represents some binary data, accessed through a #GdaBlobOp object.
* @op is generally set up by database providers when giving access to an existing BLOB in
diff --git a/libgda/gda-xa-transaction.c b/libgda/gda-xa-transaction.c
index a43f67f..66b0aff 100644
--- a/libgda/gda-xa-transaction.c
+++ b/libgda/gda-xa-transaction.c
@@ -439,8 +439,8 @@ gda_xa_transaction_begin (GdaXaTransaction *xa_trans, GError **error)
/**
* gda_xa_transaction_commit:
* @xa_trans: a #GdaXaTransaction object
- * @cnc_to_recover: a place to store the list of connections for which the commit phase failed, or %NULL
- * @error: (allow-none): a place to store errors, or %NULL
+ * @cnc_to_recover: (allow-none): a place to store the list of connections for which the commit phase failed, or %NULL
+ * @error: a place to store errors, or %NULL
*
* Commits a distributed transaction (managed by @xa_trans). The commit is composed of two phases:
* <itemizedlist>
diff --git a/libgda/sql-parser/gda-statement-struct-parts.h b/libgda/sql-parser/gda-statement-struct-parts.h
index 3008221..38433c5 100644
--- a/libgda/sql-parser/gda-statement-struct-parts.h
+++ b/libgda/sql-parser/gda-statement-struct-parts.h
@@ -49,13 +49,13 @@ typedef struct _GdaSqlSelectOrder GdaSqlSelectOrder;
/**
* GdaSqlExpr:
* @any: inheritance structure
- * @value: a #GValue, or %NULL. Please see specific note about this field.
- * @param_spec: a #GdaSqlParamSpec, or %NULL if this is not a variable
- * @func: not %NULL if expression is a function or aggregate
- * @cond: not %NULL if expression is a condition or an operation
- * @select: not %NULL if expression is a sub select statement (#GdaSqlStatementSelect or #GdaSqlStatementCompound)
- * @case_s: not %NULL if expression is a CASE WHEN ... expression
- * @cast_as: not %NULL if expression must be cast to another data type
+ * @value: (allow-none): a #GValue, or %NULL. Please see specific note about this field.
+ * @param_spec: (allow-none): a #GdaSqlParamSpec, or %NULL if this is not a variable
+ * @func: (allow-none): not %NULL if expression is a function or aggregate
+ * @cond: (allow-none): not %NULL if expression is a condition or an operation
+ * @select: (allow-none): not %NULL if expression is a sub select statement (#GdaSqlStatementSelect or #GdaSqlStatementCompound)
+ * @case_s: (allow-none): not %NULL if expression is a CASE WHEN ... expression
+ * @cast_as: (allow-none): not %NULL if expression must be cast to another data type
* @value_is_ident: Please see specific note about the @value field
*
* This structure contains any expression, either as a value (the @value part is set),
@@ -360,6 +360,17 @@ typedef enum {
GDA_SQL_SELECT_JOIN_RIGHT,
GDA_SQL_SELECT_JOIN_FULL
} GdaSqlSelectJoinType;
+
+/**
+ * GdaSqlSelectJoin:
+ * @any: inheritance structure
+ * @type: type of join
+ * @position: represents a join between a target at (pos < @position) and the one at @position
+ * @expr: (allow-none): joining expression, or %NULL
+ * @use: (allow-none): list of #GdaSqlField pointers to use when joining, or %NULL
+ *
+ * This structure represents a join between two targets in a SELECT statement.
+ */
struct _GdaSqlSelectJoin
{
GdaSqlAnyPart any;
@@ -385,6 +396,14 @@ const gchar *gda_sql_select_join_type_to_string (GdaSqlSelectJoinType type
/*
* Any FROM ... in a SELECT statement
*/
+/**
+ * GdaSqlSelectFrom:
+ * @any: inheritance structure
+ * @targets: (element-type Gda.SqlSelectTarget): list of #GdaSqlSelectTarget
+ * @joins: (element-type Gda.SqlSelectJoin): list of #GdaSqlSelectJoin
+ *
+ * This structure represents the FROM clause of a SELECT statement, it lists targets and joins
+ */
struct _GdaSqlSelectFrom
{
GdaSqlAnyPart any;
diff --git a/libgda/sql-parser/gda-statement-struct-select.c b/libgda/sql-parser/gda-statement-struct-select.c
index 588c2b3..619a0d2 100644
--- a/libgda/sql-parser/gda-statement-struct-select.c
+++ b/libgda/sql-parser/gda-statement-struct-select.c
@@ -247,7 +247,7 @@ _gda_sql_statement_select_serialize (gpointer stmt)
* gda_sql_statement_select_take_distinct
* @stmt: a #GdaSqlStatement pointer
* @distinct: a TRUE/FALSE value
- * @distinct_expr: a #GdaSqlExpr pointer representing what the DISTINCT is on, or %NULL
+ * @distinct_expr: (allow-none): a #GdaSqlExpr pointer representing what the DISTINCT is on, or %NULL
*
* Sets the DISTINCT clause of @stmt.
*
diff --git a/libgda/sql-parser/gda-statement-struct.c b/libgda/sql-parser/gda-statement-struct.c
index bbdc709..3baafbf 100644
--- a/libgda/sql-parser/gda-statement-struct.c
+++ b/libgda/sql-parser/gda-statement-struct.c
@@ -312,7 +312,7 @@ static gboolean gda_sql_select_target_check_validity (GdaSqlSelectTarget *target
/**
* gda_sql_statement_check_validity
* @stmt: a #GdaSqlStatement pointer
- * @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 all the database objects referenced in the statement actually
@@ -362,7 +362,7 @@ gda_sql_statement_check_validity (GdaSqlStatement *stmt, GdaConnection *cnc, GEr
/**
* gda_sql_statement_check_validity_m
* @stmt: a #GdaSqlStatement pointer
- * @mstruct: a #GdaMetaStruct object, or %NULL
+ * @mstruct: (allow-none): a #GdaMetaStruct object, or %NULL
* @error: a place to store errors, or %NULL
*
* If @mstruct is not %NULL, then checks that all the database objects referenced in the statement i
@@ -1379,7 +1379,7 @@ static gboolean foreach_normalize (GdaSqlAnyPart *node, GdaConnection *cnc, GErr
/**
* gda_sql_statement_normalize
* @stmt: a pointer to a #GdaSqlStatement structure
- * @cnc: a #GdaConnection object, or %NULL
+ * @cnc: (allow-none): a #GdaConnection object, or %NULL
* @error: a place to store errors, or %NULL
*
* "Normalizes" (in place) some parts of @stmt, which means @stmt may be modified.
diff --git a/libgda/sqlite/virtual/gda-ldap-connection.h b/libgda/sqlite/virtual/gda-ldap-connection.h
index ba2ddfd..202c577 100644
--- a/libgda/sqlite/virtual/gda-ldap-connection.h
+++ b/libgda/sqlite/virtual/gda-ldap-connection.h
@@ -136,7 +136,7 @@ gboolean gda_ldap_connection_describe_table (GdaLdapConnection *cnc, cons
* GdaLdapAttribute:
* @attr_name: the name of the attribute
* @nb_values: the number of values in @values, or %0
- * @values: (allow-none) (array length=nb_values): the attribute' values as #GValue values, (terminated by a %NULL)
+ * @values: (allow-none) (array length=nb_values) (array zero-terminated=1): the attribute' values as #GValue values, (terminated by a %NULL)
*
* This structure holds information about the values of a single attribute (of a single LDAP entry).
*/
@@ -150,7 +150,7 @@ typedef struct {
* GdaLdapEntry:
* @dn: the Distinguished Name of the entry
* @nb_attributes: the number of attributes in @attributes, or %0
- * @attributes: (allow-none) (array length=nb_attributes): the entry's attributes, (terminated by a %NULL)
+ * @attributes: (allow-none) (array length=nb_attributes) (array zero-terminated=1): the entry's attributes, (terminated by a %NULL)
* @attributes_hash: a hash table where the key is an attribute name, and the value the correcponding #GdaLdapAttribute
*
* This structure holds information about the attributes of a single LDAP entry.
diff --git a/libgda/sqlite/virtual/gda-vconnection-data-model.c b/libgda/sqlite/virtual/gda-vconnection-data-model.c
index 533b8f3..0d12b10 100644
--- a/libgda/sqlite/virtual/gda-vconnection-data-model.c
+++ b/libgda/sqlite/virtual/gda-vconnection-data-model.c
@@ -251,7 +251,7 @@ gda_vconnection_data_model_add_model (GdaVconnectionDataModel *cnc,
* gda_vconnection_data_model_add:
* @cnc: a #GdaVconnectionDataModel connection
* @spec: a #GdaVconnectionDataModelSpec structure, used AS IS (not copied) and can be modified
- * @spec_free_func: function to call when freeing @spec, or %NULL
+ * @spec_free_func: (allow-none): function to call when freeing @spec, or %NULL
* @table_name: the name of the table
* @error: a place to store errors, or %NULL
*
diff --git a/libgda/sqlite/virtual/gda-vconnection-data-model.h b/libgda/sqlite/virtual/gda-vconnection-data-model.h
index 03f368a..1db12dd 100644
--- a/libgda/sqlite/virtual/gda-vconnection-data-model.h
+++ b/libgda/sqlite/virtual/gda-vconnection-data-model.h
@@ -59,7 +59,7 @@ typedef GdaDataModel *(*GdaVconnectionDataModelCreateModelFunc) (GdaVconnectionD
/**
* GdaVconnectionDataModelFunc:
- * @Param1: a pointer to a #GdaDataModel
+ * @Param1: (allow-none): a pointer to a #GdaDataModel
* @Param2: the name of the table represented by @Param1
* @Param3: a data pointer, passed as last ergument to gda_vconnection_data_model_foreach()
*
@@ -135,11 +135,11 @@ typedef GdaDataModel *(*GdaVconnectionDataModelCreateFModelFunc) (GdaVconnection
/**
* GdaVconnectionDataModelSpec:
- * @data_model: a #GdaDataModel, or %NULL
- * @create_columns_func: a pointer to a #GdaVconnectionDataModelCreateColumnsFunc function, or %NULL
- * @create_model_func: a pointer to a #GdaVconnectionDataModelCreateModelFunc function, or %NULL
- * @create_filter_func: a pointer to a #GdaVconnectionDataModelParseFilterFunc function, or %NULL
- * @create_filtered_model_func: a pointer to a #GdaVconnectionDataModelCreateFModelFunc function, or %NULL
+ * @data_model: (allow-none): a #GdaDataModel, or %NULL
+ * @create_columns_func: (allow-none): a pointer to a #GdaVconnectionDataModelCreateColumnsFunc function, or %NULL
+ * @create_model_func: (allow-none): a pointer to a #GdaVconnectionDataModelCreateModelFunc function, or %NULL
+ * @create_filter_func: (allow-none): a pointer to a #GdaVconnectionDataModelParseFilterFunc function, or %NULL
+ * @create_filtered_model_func: (allow-none): a pointer to a #GdaVconnectionDataModelCreateFModelFunc function, or %NULL
*
* This structure holds all the information supplied to declare a virtual table using
* gda_vconnection_data_model_add(). You don't need to provider pointers for all the functions and
diff --git a/libgda/sqlite/virtual/gda-vconnection-hub.c b/libgda/sqlite/virtual/gda-vconnection-hub.c
index 09f9db6..4c2fae4 100644
--- a/libgda/sqlite/virtual/gda-vconnection-hub.c
+++ b/libgda/sqlite/virtual/gda-vconnection-hub.c
@@ -131,7 +131,7 @@ gda_vconnection_hub_get_type (void)
* gda_vconnection_hub_add:
* @hub: a #GdaVconnectionHub connection
* @cnc: a #GdaConnection
- * @ns: a namespace, or %NULL
+ * @ns: (allow-none): a namespace, or %NULL
* @error: a place to store errors, or %NULL
*
* Make all the tables of @cnc appear as tables (of the same name) in the @hub connection.
@@ -240,7 +240,7 @@ get_hub_cnc_by_cnc (GdaVconnectionHub *hub, GdaConnection *cnc)
/**
* gda_vconnection_hub_get_connection:
* @hub: a #GdaVconnectionHub connection
- * @ns: a name space, or %NULL
+ * @ns: (allow-none): a name space, or %NULL
*
* Find the #GdaConnection object in @hub associated to the @ns name space
*
diff --git a/libgda/thread-wrapper/gda-thread-wrapper.c b/libgda/thread-wrapper/gda-thread-wrapper.c
index fd72451..5ead28f 100644
--- a/libgda/thread-wrapper/gda-thread-wrapper.c
+++ b/libgda/thread-wrapper/gda-thread-wrapper.c
@@ -439,8 +439,8 @@ clean_notifications (GdaThreadWrapper *wrapper, ThreadData *td)
}
/*
- * @wrapper: may be %NULL
- * @td: may be %NULL
+ * @wrapper: (allow-none): may be %NULL
+ * @td: (allow-none): may be %NULL
*
* Either @wrapper and @td are both NULL, or they are both NOT NULL
*/
@@ -835,9 +835,9 @@ gda_thread_wrapper_unset_io_channel (GdaThreadWrapper *wrapper)
/**
* gda_thread_wrapper_execute:
* @wrapper: a #GdaThreadWrapper object
- * @func: the function to execute
- * @arg: argument to pass to @func
- * @arg_destroy_func: function to be called when the execution has finished, to destroy @arg
+ * @func: the function to execute, not %NULL
+ * @arg: (allow-none): argument to pass to @func, or %NULL
+ * @arg_destroy_func: (allow-none): function to be called when the execution has finished, to destroy @arg, or %NULL
* @error: a place to store errors, for errors occurring in this method, not errors occurring while @func
* is executed, or %NULL
*
@@ -848,8 +848,8 @@ gda_thread_wrapper_unset_io_channel (GdaThreadWrapper *wrapper)
* This method returns immediately, and the caller then needs to use gda_thread_wrapper_fetch_result() to
* check if the execution has finished and get the result.
*
- * Once @func's execution is finished, if it is not %NULL, the @arg_destroy_func destruction function is called
- * on @arg. This occurs in the thread calling gda_thread_wrapper_fetch_result().
+ * Once @func's execution is finished, if @arg is not %NULL, the @arg_destroy_func destruction function is called
+ * on @arg. This call occurs in the thread calling gda_thread_wrapper_fetch_result().
*
* Returns: the job ID, or 0 if an error occurred
*
@@ -911,11 +911,11 @@ gda_thread_wrapper_execute (GdaThreadWrapper *wrapper, GdaThreadWrapperFunc func
}
/**
- * gda_thread_wrapper_execute_void
+ * gda_thread_wrapper_execute_void:
* @wrapper: a #GdaThreadWrapper object
- * @func: the function to execute
- * @arg: argument to pass to @func
- * @arg_destroy_func: function to be called when the execution has finished, to destroy @arg
+ * @func: the function to execute, not %NULL
+ * @arg: (allow-none): argument to pass to @func
+ * @arg_destroy_func: (allow-none): function to be called when the execution has finished, to destroy @arg, or %NULL
* @error: a place to store errors, for errors occurring in this method, not errors occurring while @func
* is executed, or %NULL
*
@@ -928,8 +928,8 @@ gda_thread_wrapper_execute (GdaThreadWrapper *wrapper, GdaThreadWrapperFunc func
* chance to execute the @arg_destroy_func function if not %NULL (note that gda_thread_wrapper_iterate() is
* called by gda_thread_wrapper_fetch_result() itself).
*
- * Once @func's execution is finished, if it is not %NULL, the @arg_destroy_func destruction function is called
- * on @arg. This occurs in the thread calling gda_thread_wrapper_fetch_result().
+ * Once @func's execution is finished, if @arg is not %NULL, the @arg_destroy_func destruction function is called
+ * on @arg. This call occurs in the thread calling gda_thread_wrapper_fetch_result().
*
* Returns: the job ID, or 0 if an error occurred
*
diff --git a/tests/gda-ddl-creator.c b/tests/gda-ddl-creator.c
index b6d3229..8ca01b4 100644
--- a/tests/gda-ddl-creator.c
+++ b/tests/gda-ddl-creator.c
@@ -661,7 +661,7 @@ create_server_operation_for_view (G_GNUC_UNUSED GdaDDLCreator *ddlc, GdaServerPr
/**
* gda_ddl_creator_set_connection
* @ddlc: a #GdaDDLCreator object
- * @cnc: a #GdaConnection object or %NULL
+ * @cnc: (allow-none): a #GdaConnection object or %NULL
*
*
*/
diff --git a/tools/browser/browser-connections-list.c b/tools/browser/browser-connections-list.c
index c91ed44..2001c23 100644
--- a/tools/browser/browser-connections-list.c
+++ b/tools/browser/browser-connections-list.c
@@ -307,7 +307,7 @@ connection_new_cb (G_GNUC_UNUSED GtkButton *button, G_GNUC_UNUSED BrowserConnect
/**
* browser_connections_list_show
- * @current: a connection to select for displaed properties, or %NULL
+ * @current: (allow-none): a connection to select for displaed properties, or %NULL
*
* Creates a new #BrowserConnectionsList widget and displays it.
* Only one is created and shown (singleton)
diff --git a/tools/browser/browser-favorites.c b/tools/browser/browser-favorites.c
index 52e84ab..a86326a 100644
--- a/tools/browser/browser-favorites.c
+++ b/tools/browser/browser-favorites.c
@@ -1066,7 +1066,7 @@ browser_favorites_delete (BrowserFavorites *bfav, guint session_id,
* @bfav: a #BrowserFavorites
* @session_id: 0 for now
* @contents: the favorite's contents
- * @out_fav: a #BrowserFavoritesAttributes to be filled with the favorite's attributes, or %NULL
+ * @out_fav: (allow-none): a #BrowserFavoritesAttributes to be filled with the favorite's attributes, or %NULL
* @error: a place to store errors, or %NULL
*
* Get all the information about a favorite from its id: fills the @out_fav
@@ -1284,7 +1284,7 @@ browser_favorites_get_actions (BrowserFavorites *bfav, BrowserConnection *bcnc,
/**
* browser_favorites_free_action
- * @action: a #BrowserFavoriteAction, or %NULL
+ * @action: (allow-none): a #BrowserFavoriteAction, or %NULL
*
* Frees @action
*/
@@ -1303,7 +1303,7 @@ browser_favorites_free_action (BrowserFavoriteAction *action)
/**
* browser_favorites_free_actions_list
- * @actions_list: a list of #BrowserFavoriteAction, or %NULL
+ * @actions_list: (allow-none): a list of #BrowserFavoriteAction, or %NULL
*
* Free a list of #BrowserFavoriteAction (frees the list and each #BrowserFavoriteAction)
*/
diff --git a/tools/browser/browser-window.c b/tools/browser/browser-window.c
index fafac6d..655acfc 100644
--- a/tools/browser/browser-window.c
+++ b/tools/browser/browser-window.c
@@ -1311,7 +1311,7 @@ browser_window_get_connection (BrowserWindow *bwin)
/*
* perspective_data_new
* @bwin: a #BrowserWindow in which the perspective will be
- * @factory: a #BrowserPerspectiveFactory, or %NULL
+ * @factory: (allow-none): a #BrowserPerspectiveFactory, or %NULL
*
* Creates a new #PerspectiveData structure, it increases @bcnc's reference count.
*
@@ -1648,8 +1648,8 @@ browser_window_show_notice (BrowserWindow *bwin, GtkMessageType type, const gcha
* browser_window_customize_perspective_ui
* @bwin: a #BrowserWindow
* @bpers: the #BrowserPerspective concerned
- * @actions_group: a #GtkActionGroup object, or %NULL
- * @ui_info: a merge UI string, or %NULL. See gtk_ui_manager_add_ui_from_string()
+ * @actions_group: (allow-none): a #GtkActionGroup object, or %NULL
+ * @ui_info: (allow-none): a merge UI string, or %NULL. See gtk_ui_manager_add_ui_from_string()
*
* Customizes a UI specific to the @bpers perspective. Any
* previous customization is removed, replaced by the new requested one.
diff --git a/tools/browser/canvas/browser-canvas-column.c b/tools/browser/canvas/browser-canvas-column.c
index 252d724..140d6a0 100644
--- a/tools/browser/canvas/browser-canvas-column.c
+++ b/tools/browser/canvas/browser-canvas-column.c
@@ -217,8 +217,8 @@ browser_canvas_column_extra_event (BrowserCanvasItem *citem, GdkEventType event
}
/**
- * browser_canvas_column_new
- * @parent: the parent item, or %NULL
+ * browser_canvas_column_new: (skip)
+ * @parent: (allow-none): the parent item, or %NULL
* @mstruct: the #GdaMetaStruct @column is from
* @column: the represented entity's column
* @x: the x coordinate of the text
diff --git a/tools/browser/canvas/browser-canvas-db-relations.c b/tools/browser/canvas/browser-canvas-db-relations.c
index 7b0210f..33b526b 100644
--- a/tools/browser/canvas/browser-canvas-db-relations.c
+++ b/tools/browser/canvas/browser-canvas-db-relations.c
@@ -318,7 +318,7 @@ cloud_object_selected_cb (G_GNUC_UNUSED ObjectsCloud *ocloud, G_GNUC_UNUSED Obje
/**
* browser_canvas_db_relations_new
- * @mstruct: a #GdaMetaStruct object, or %NULL
+ * @mstruct: (allow-none): a #GdaMetaStruct object, or %NULL
*
* Creates a new canvas widget to display the relations between the database's tables.
*
@@ -882,8 +882,8 @@ browser_canvas_db_relations_get_table_item (BrowserCanvasDbRelations *canvas, G
/**
* browser_canvas_db_relations_add_table
* @canvas: a #BrowserCanvasDbRelations canvas
- * @table_catalog: the catalog in which the table is, or %NULL
- * @table_schema: the schema in which the table is, or %NULL
+ * @table_catalog: (allow-none): the catalog in which the table is, or %NULL
+ * @table_schema: (allow-none): the schema in which the table is, or %NULL
* @table_name: the table's name
*
* Add a table to @canvas.
diff --git a/tools/browser/canvas/browser-canvas-item.c b/tools/browser/canvas/browser-canvas-item.c
index db67599..4a7db78 100644
--- a/tools/browser/canvas/browser-canvas-item.c
+++ b/tools/browser/canvas/browser-canvas-item.c
@@ -267,8 +267,8 @@ browser_canvas_item_get_canvas (BrowserCanvasItem *item)
/**
* browser_canvas_item_get_edge_nodes
* @item: a #BrowserCanvasItem object
- * @from: a place to store the FROM part of the edge, or %NULL
- * @to: a place to store the TO part of the edge, or %NULL
+ * @from: (allow-none): a place to store the FROM part of the edge, or %NULL
+ * @to: (allow-none): a place to store the TO part of the edge, or %NULL
*
* If the @item canvas item represents a "link" between two other canvas items (an edge), then
* set @from and @to to those items.
diff --git a/tools/browser/common/fk-declare.c b/tools/browser/common/fk-declare.c
index 77a5b3d..c078768 100644
--- a/tools/browser/common/fk-declare.c
+++ b/tools/browser/common/fk-declare.c
@@ -545,7 +545,7 @@ update_dialog_response_sensitiveness (FkDeclare *decl)
/**
* fk_declare_write
* @decl: a #FkDeclare widget
- * @bwin: a #BrowserWindow, or %NULL
+ * @bwin: (allow-none): a #BrowserWindow, or %NULL
* @error: a place to store errors or %NULL
*
* Actually declares the new foreign key in the meta store
@@ -617,7 +617,7 @@ fk_declare_write (FkDeclare *decl, BrowserWindow *bwin, GError **error)
/**
* fk_declare_undeclare:
* @mstruct: the #GdaMEtaStruct to delete the FK from
- * @bwin: a #BrowserWindow, or %NULL
+ * @bwin: (allow-none): a #BrowserWindow, or %NULL
* @decl_fk: the #GdaMetaTableForeignKey fk to delete
* @error: a place to store errors, or %NULL
*
diff --git a/tools/browser/common/ui-formgrid.c b/tools/browser/common/ui-formgrid.c
index e8bfa55..3c7d624 100644
--- a/tools/browser/common/ui-formgrid.c
+++ b/tools/browser/common/ui-formgrid.c
@@ -828,7 +828,7 @@ ui_formgrid_new (GdaDataModel *model, gboolean scroll_form, GdauiDataProxyInfoFl
/**
* ui_formgrid_handle_user_prefs
* @formgrid: a #UiFormGrid widget
- * @bcnc: a #BrowserConnection, or %NULL to let @formgrid determine it itself
+ * @bcnc: (allow-none): a #BrowserConnection, or %NULL to let @formgrid determine it itself
* @stmt: the #GdaStatement which has been executed to produce the #GdaDataModel displayed in @formgrid
*
* Takes into account the UI preferences of the user
@@ -1051,7 +1051,7 @@ ui_formgrid_get_grid_widget (UiFormGrid *formgrid)
/**
* ui_formgrid_set_connection
* @formgrid: a #UiFormGrid widget
- * @bcnc: a #BrowserConnection, or %NULL
+ * @bcnc: (allow-none): a #BrowserConnection, or %NULL
*
* Tells @formgrid to use @bcnc as connection when actions have to be executed
*/
diff --git a/tools/browser/data-manager/data-source-editor.c b/tools/browser/data-manager/data-source-editor.c
index c8dc949..7fe4a73 100644
--- a/tools/browser/data-manager/data-source-editor.c
+++ b/tools/browser/data-manager/data-source-editor.c
@@ -235,7 +235,7 @@ update_dependencies_display (DataSourceEditor *editor)
/**
* data_source_editor_display_source
* @editor: a #DataSourceEditor widget
- * @source: the #DataSource for which properties are displayed, or %NULL
+ * @source: (allow-none): the #DataSource for which properties are displayed, or %NULL
*
* Update @editor's display with @source's properties
*/
diff --git a/tools/browser/data-manager/data-source-manager.c b/tools/browser/data-manager/data-source-manager.c
index 4b20ba0..339344f 100644
--- a/tools/browser/data-manager/data-source-manager.c
+++ b/tools/browser/data-manager/data-source-manager.c
@@ -372,7 +372,7 @@ data_source_manager_add_source (DataSourceManager *mgr, DataSource *source)
/**
* data_source_manager_replace_all
* @mgr: a #DataSourceManager object
- * @sources_list: a list of #DataSource objects, or %NULL
+ * @sources_list: (allow-none): a list of #DataSource objects, or %NULL
*
* Replaces all the data sources by the ones in @sources_list.
*/
diff --git a/tools/browser/data-manager/data-source.c b/tools/browser/data-manager/data-source.c
index 4a8df34..69d3335 100644
--- a/tools/browser/data-manager/data-source.c
+++ b/tools/browser/data-manager/data-source.c
@@ -541,9 +541,9 @@ init_from_table_node (DataSource *source, xmlNodePtr node, GError **error)
* data_source_add_dependency
* @source: a #DataSource
* @table: the name of the referenced table
- * @id: the ID of the referenced data source, or %NULL if its ID is the same as the table name
+ * @id: (allow-none): the ID of the referenced data source, or %NULL if its ID is the same as the table name
* @col_name_size: the size of @col_names
- * @col_names: names of the FK columns involved in the foreign key, or %NULL
+ * @col_names: (allow-none): names of the FK columns involved in the foreign key, or %NULL
* @error: a place to store errors, or %NULL
*
* Adds a dependency on the @table table, only for DATA_SOURCE_TABLE sources
diff --git a/tools/browser/query-exec/query-editor.c b/tools/browser/query-exec/query-editor.c
index d813188..07eca4c 100644
--- a/tools/browser/query-exec/query-editor.c
+++ b/tools/browser/query-exec/query-editor.c
@@ -1213,7 +1213,7 @@ get_date_format (time_t time)
/**
* query_editor_start_history_batch
* @editor: a #QueryEditor widget.
- * @hist_batch: a #QueryEditorHistoryBatch to add, or %NULL
+ * @hist_batch: (allow-none): a #QueryEditorHistoryBatch to add, or %NULL
*
* @hist_hash ref is _NOT_ stolen here
*/
@@ -1330,7 +1330,7 @@ timestamps_update_cb (QueryEditor *editor)
/**
* query_editor_add_history_item
* @editor: a #QueryEditor widget.
- * @hist_item: a #QueryEditorHistoryItem to add, or %NULL
+ * @hist_item: (allow-none): a #QueryEditorHistoryItem to add, or %NULL
*
* Adds some text. @text_data is useful only if @editor's mode is HISTORY, it will be ignored
* otherwise.
@@ -1405,7 +1405,7 @@ query_editor_add_history_item (QueryEditor *editor, QueryEditorHistoryItem *hist
/**
* query_editor_get_current_history_item
* @editor: a #QueryEditor widget.
- * @out_in_batch: a pointer to store the #QueryEditorHistoryBatch the returned item is in, or %NULL
+ * @out_in_batch: (allow-none): a pointer to store the #QueryEditorHistoryBatch the returned item is in, or %NULL
*
* Get the current selected #QueryEditorHistoryItem
* passed to query_editor_add_history_item().
diff --git a/tools/browser/support.c b/tools/browser/support.c
index e3609f4..113b54c 100644
--- a/tools/browser/support.c
+++ b/tools/browser/support.c
@@ -201,7 +201,7 @@ browser_show_message (GtkWindow *parent, const gchar *format, ...)
#ifdef HAVE_GDU
/**
* browser_show_help
- * @topic: the help topic, or %NULL for the global index
+ * @topic: (allow-none): the help topic, or %NULL for the global index
*/
void
browser_show_help (GtkWindow *parent, const gchar *topic)
diff --git a/tools/gda-tree-mgr-xml.c b/tools/gda-tree-mgr-xml.c
index ec72cce..4c2317b 100644
--- a/tools/gda-tree-mgr-xml.c
+++ b/tools/gda-tree-mgr-xml.c
@@ -115,7 +115,7 @@ gda_tree_mgr_xml_get_type (void)
/**
* gda_tree_mgr_xml_new:
* rootnode: the #xmlNodePtr root
- * xml_attributes: a string containing the XML attributes which will appear in each node, separated by the | character, or %NULL to list all attributes
+ * xml_attributes: (allow-none): a string containing the XML attributes which will appear in each node, separated by the | character, or %NULL to list all attributes
*
* Creates a new #GdaTreeManager object which will add one tree node for each
* subnodes of an XmlNodePtr
diff --git a/tools/web-server.c b/tools/web-server.c
index f674979..65cace0 100644
--- a/tools/web-server.c
+++ b/tools/web-server.c
@@ -327,7 +327,7 @@ server_callback (G_GNUC_UNUSED SoupServer *server, SoupMessage *msg,
/**
* web_server_new
* @type: the #GType requested
- * @auth_token: the authentication token, or %NULL
+ * @auth_token: (allow-none): the authentication token, or %NULL
*
* Creates a new server of type @type
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]