[libgda] More introspection annotations for LibgdaUI
- From: Vivien Malerba <vivien src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgda] More introspection annotations for LibgdaUI
- Date: Tue, 21 Sep 2010 18:55:40 +0000 (UTC)
commit c950942a1deb3d8fb06075a713749c8f7209524a
Author: Vivien Malerba <malerba gnome-db org>
Date: Tue Sep 21 20:54:00 2010 +0200
More introspection annotations for LibgdaUI
.../data-entries/gdaui-data-cell-renderer-bin.c | 2 +-
.../gdaui-data-cell-renderer-boolean.c | 2 +-
.../data-entries/gdaui-data-cell-renderer-combo.c | 4 +-
.../data-entries/gdaui-data-cell-renderer-info.c | 10 ++--
.../gdaui-data-cell-renderer-textual.c | 4 +-
libgda-ui/data-entries/gdaui-entry-bin.c | 6 +-
libgda-ui/data-entries/gdaui-entry-boolean.c | 6 +-
libgda-ui/data-entries/gdaui-entry-combo.c | 32 ++++++------
libgda-ui/data-entries/gdaui-entry-common-time.c | 8 ++--
libgda-ui/data-entries/gdaui-entry-date.c | 8 ++--
libgda-ui/data-entries/gdaui-entry-none.c | 6 +-
libgda-ui/data-entries/gdaui-entry-number.c | 8 ++--
libgda-ui/data-entries/gdaui-entry-shell.c | 8 ++--
libgda-ui/data-entries/gdaui-entry-string.c | 6 +-
libgda-ui/data-entries/gdaui-entry-timestamp.c | 8 ++--
libgda-ui/data-entries/gdaui-entry-wrapper.c | 6 +-
libgda-ui/data-entries/gdaui-entry.c | 18 +++---
libgda-ui/data-entries/gdaui-formatted-entry.c | 14 +++---
libgda-ui/data-entries/gdaui-numeric-entry.c | 8 ++--
libgda-ui/data-entries/widget-embedder.c | 4 ++
libgda-ui/gdaui-basic-form.c | 58 ++++++++++----------
libgda-ui/gdaui-cloud.c | 22 ++++----
libgda-ui/gdaui-combo.c | 20 ++++----
libgda-ui/gdaui-data-entry.c | 50 +++++++++---------
libgda-ui/gdaui-data-filter.c | 6 +-
libgda-ui/gdaui-data-proxy-info.c | 6 +-
libgda-ui/gdaui-data-proxy.c | 22 ++++----
libgda-ui/gdaui-data-selector.c | 25 ++++-----
libgda-ui/gdaui-data-store.c | 30 +++++-----
libgda-ui/gdaui-form.c | 7 +--
libgda-ui/gdaui-grid.c | 13 +++--
libgda-ui/gdaui-init.c | 10 ++--
libgda-ui/gdaui-login.c | 14 +++---
libgda-ui/gdaui-provider-selector.c | 20 ++++----
libgda-ui/gdaui-raw-form.c | 6 +-
libgda-ui/gdaui-raw-grid.c | 13 +++--
36 files changed, 249 insertions(+), 241 deletions(-)
---
diff --git a/libgda-ui/data-entries/gdaui-data-cell-renderer-bin.c b/libgda-ui/data-entries/gdaui-data-cell-renderer-bin.c
index db353a3..b3255a7 100644
--- a/libgda-ui/data-entries/gdaui-data-cell-renderer-bin.c
+++ b/libgda-ui/data-entries/gdaui-data-cell-renderer-bin.c
@@ -327,7 +327,7 @@ gdaui_data_cell_renderer_bin_set_property (GObject *object,
* in the model, thus causing the check button to reflect the state of
* the model.
*
- * Return value: the new cell renderer
+ * Return value: (transfer full): the new cell renderer
*/
GtkCellRenderer *
gdaui_data_cell_renderer_bin_new (GdaDataHandler *dh, GType type)
diff --git a/libgda-ui/data-entries/gdaui-data-cell-renderer-boolean.c b/libgda-ui/data-entries/gdaui-data-cell-renderer-boolean.c
index 62dca29..153557b 100644
--- a/libgda-ui/data-entries/gdaui-data-cell-renderer-boolean.c
+++ b/libgda-ui/data-entries/gdaui-data-cell-renderer-boolean.c
@@ -335,7 +335,7 @@ gdaui_data_cell_renderer_boolean_set_property (GObject *object,
* in the model, thus causing the check button to reflect the state of
* the model.
*
- * Return value: the new cell renderer
+ * Return value: (transfer full): the new cell renderer
*/
GtkCellRenderer *
gdaui_data_cell_renderer_boolean_new (GdaDataHandler *dh, GType type)
diff --git a/libgda-ui/data-entries/gdaui-data-cell-renderer-combo.c b/libgda-ui/data-entries/gdaui-data-cell-renderer-combo.c
index 937e2e0..3720c95 100644
--- a/libgda-ui/data-entries/gdaui-data-cell-renderer-combo.c
+++ b/libgda-ui/data-entries/gdaui-data-cell-renderer-combo.c
@@ -430,14 +430,14 @@ render_text_to_display_from_values (GList *values)
}
/**
- * gdaui_data_cell_renderer_combo_new
+ * gdaui_data_cell_renderer_combo_new:
* @paramlist: a #GdaSet object
* @source: a #GdauiSetSource structure listed in @paramlist->sources_list
*
* Creates a new #GdauiDataCellRendererCombo which will fill the parameters listed in
* @source->nodes with values available from @source->data_model.
*
- * Return value: the new cell renderer
+ * Return value: (transfer full): the new cell renderer
**/
GtkCellRenderer *
gdaui_data_cell_renderer_combo_new (GdauiSet *paramlist, GdauiSetSource *source)
diff --git a/libgda-ui/data-entries/gdaui-data-cell-renderer-info.c b/libgda-ui/data-entries/gdaui-data-cell-renderer-info.c
index a7008be..26ce877 100644
--- a/libgda-ui/data-entries/gdaui-data-cell-renderer-info.c
+++ b/libgda-ui/data-entries/gdaui-data-cell-renderer-info.c
@@ -294,9 +294,9 @@ gdaui_data_cell_renderer_info_set_property (GObject *object,
/**
* gdaui_data_cell_renderer_info_new:
- * @store:
- * @iter:
- * @node:
+ * @store: a #GdauiDataStore
+ * @iter: a #GdaDataModelIter
+ * @node: a #GdauiSetGroup pointer
*
* Creates a new #GdauiDataCellRendererInfo. Adjust rendering
* parameters using object properties. Object properties can be set
@@ -306,11 +306,11 @@ gdaui_data_cell_renderer_info_set_property (GObject *object,
* in the model, thus causing the check button to reflect the state of
* the model.
*
- * Returns: the new cell renderer
+ * Returns: (transfer full): the new cell renderer
**/
GtkCellRenderer *
gdaui_data_cell_renderer_info_new (GdauiDataStore *store,
- GdaDataModelIter *iter, GdauiSetGroup *group)
+ GdaDataModelIter *iter, GdauiSetGroup *group)
{
GObject *obj;
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 db37f07..1c31f58 100644
--- a/libgda-ui/data-entries/gdaui-data-cell-renderer-textual.c
+++ b/libgda-ui/data-entries/gdaui-data-cell-renderer-textual.c
@@ -554,7 +554,7 @@ gdaui_data_cell_renderer_textual_set_property (GObject *object,
}
/**
- * gdaui_data_cell_renderer_textual_new
+ * gdaui_data_cell_renderer_textual_new:
* @dh: a #GdaDataHandler object, or %NULL
* @type: the #GType being edited
* @options: options as a string
@@ -567,7 +567,7 @@ gdaui_data_cell_renderer_textual_set_property (GObject *object,
* value in the model, thus rendering a different string in each row
* of the #GtkTreeView
*
- * Return value: the new cell renderer
+ * Return value: (transfer full): the new cell renderer
**/
GtkCellRenderer *
gdaui_data_cell_renderer_textual_new (GdaDataHandler *dh, GType type, const gchar *options)
diff --git a/libgda-ui/data-entries/gdaui-entry-bin.c b/libgda-ui/data-entries/gdaui-entry-bin.c
index 2a4f236..996b151 100644
--- a/libgda-ui/data-entries/gdaui-entry-bin.c
+++ b/libgda-ui/data-entries/gdaui-entry-bin.c
@@ -144,13 +144,13 @@ show (GtkWidget *widget)
}
/**
- * gdaui_entry_bin_new
+ * gdaui_entry_bin_new:
* @dh: the data handler to be used by the new widget
* @type: the requested data type (compatible with @dh)
*
- * Creates a new widget which is mainly a GtkEntry
+ * Creates a new widget which is mainly a #GtkEntry
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*/
GtkWidget *
gdaui_entry_bin_new (GdaDataHandler *dh, GType type)
diff --git a/libgda-ui/data-entries/gdaui-entry-boolean.c b/libgda-ui/data-entries/gdaui-entry-boolean.c
index fe2cb4c..79dc434 100644
--- a/libgda-ui/data-entries/gdaui-entry-boolean.c
+++ b/libgda-ui/data-entries/gdaui-entry-boolean.c
@@ -99,13 +99,13 @@ gdaui_entry_boolean_init (GdauiEntryBoolean * gdaui_entry_boolean)
}
/**
- * gdaui_entry_boolean_new
+ * gdaui_entry_boolean_new:
* @dh: the data handler to be used by the new widget
* @type: the requested data type (compatible with @dh)
*
- * Creates a new widget which is mainly a GtkEntry
+ * Creates a new data entry widget
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*/
GtkWidget *
gdaui_entry_boolean_new (GdaDataHandler *dh, GType type)
diff --git a/libgda-ui/data-entries/gdaui-entry-combo.c b/libgda-ui/data-entries/gdaui-entry-combo.c
index 7689ff2..1cf6a93 100644
--- a/libgda-ui/data-entries/gdaui-entry-combo.c
+++ b/libgda-ui/data-entries/gdaui-entry-combo.c
@@ -1,6 +1,6 @@
/* gdaui-entry-combo.c
*
- * Copyright (C) 2003 - 2009 Vivien Malerba <malerba gnome-db org>
+ * Copyright (C) 2003 - 2010 Vivien Malerba <malerba gnome-db org>
*
* This Library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public License as
@@ -214,7 +214,7 @@ gdaui_entry_combo_init (GdauiEntryCombo *combo)
}
/**
- * gdaui_entry_combo_new
+ * gdaui_entry_combo_new:
* @paramlist: a #GdauiSet object
* @source: a #GdauiSetSource structure, part of @paramlist
*
@@ -224,7 +224,7 @@ gdaui_entry_combo_init (GdauiEntryCombo *combo)
* The widget allows the value setting of one or more #GdaHolder objects
* (one for each 'source->nodes') while proposing potentially "more readable" choices.
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*/
GtkWidget *
gdaui_entry_combo_new (GdauiSet *paramlist, GdauiSetSource *source)
@@ -448,9 +448,9 @@ combo_contents_changed_cb (GdauiCombo *entry, GdauiEntryCombo *combo)
}
/**
- * gdaui_entry_combo_set_values
+ * gdaui_entry_combo_set_values:
* @combo: a #GdauiEntryCombo widet
- * @values: a list of #GValue values, or %NULL
+ * @values: (element-type GValue): 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.
@@ -463,7 +463,7 @@ combo_contents_changed_cb (GdauiCombo *entry, GdauiEntryCombo *combo)
*
* If @values is %NULL, then the entry itself is set to NULL;
*
- * Returns: TRUE if no error occurred.
+ * Returns: %TRUE if no error occurred.
*/
gboolean
gdaui_entry_combo_set_values (GdauiEntryCombo *combo, GSList *values)
@@ -542,14 +542,14 @@ gdaui_entry_combo_set_values (GdauiEntryCombo *combo, GSList *values)
}
/**
- * gdaui_entry_combo_get_values
+ * gdaui_entry_combo_get_values:
* @combo: a #GdauiEntryCombo widet
*
* Get the values stored within @combo. The returned values are the ones
* within @combo, so they must not be freed afterwards, however the returned
* list has to be freed afterwards.
*
- * Returns: a new list of values
+ * Returns: (transfer container) (element-type GValue): a new list of values
*/
GSList *
gdaui_entry_combo_get_values (GdauiEntryCombo *combo)
@@ -568,13 +568,13 @@ gdaui_entry_combo_get_values (GdauiEntryCombo *combo)
}
/**
- * gdaui_entry_combo_get_all_values
+ * gdaui_entry_combo_get_all_values:
* @combo: a #GdauiEntryCombo widet
*
* Get a list of all the values in @combo's data model's selected row. The list
* must be freed by the caller.
*
- * Returns: a new list of values
+ * Returns: (transfer container) (element-type GValue): a new list of values
*/
GSList *
gdaui_entry_combo_get_all_values (GdauiEntryCombo *combo)
@@ -586,9 +586,9 @@ gdaui_entry_combo_get_all_values (GdauiEntryCombo *combo)
}
/**
- * gdaui_entry_combo_set_reference_values
+ * gdaui_entry_combo_set_reference_values:
* @combo: a #GdauiEntryCombo widet
- * @values: a list of #GValue values
+ * @values: (element-type GValue): a list of #GValue values
*
* Sets the original values of @combo to the specified ones. None of the
* values provided in the list is modified.
@@ -654,13 +654,13 @@ gdaui_entry_combo_set_reference_values (GdauiEntryCombo *combo, GSList *values)
}
/**
- * gdaui_entry_combo_get_reference_values
+ * gdaui_entry_combo_get_reference_values:
* @combo: a #GdauiEntryCombo widet
*
* Get the original values stored within @combo. The returned values are the ones
* within @combo, so they must not be freed afterwards; the list has to be freed afterwards.
*
- * Returns: a new list of values
+ * Returns: (transfer container) (element-type GValue): a new list of values
*/
GSList *
gdaui_entry_combo_get_reference_values (GdauiEntryCombo *combo)
@@ -691,9 +691,9 @@ gdaui_entry_combo_get_reference_values (GdauiEntryCombo *combo)
}
/**
- * gdaui_entry_combo_set_default_values
+ * gdaui_entry_combo_set_default_values:
* @combo: a #GdauiEntryCombo widet
- * @values: a list of #GValue values
+ * @values: (element-type GValue): a list of #GValue values
*
* Sets the default 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-common-time.c b/libgda-ui/data-entries/gdaui-entry-common-time.c
index 755c08a..972f528 100644
--- a/libgda-ui/data-entries/gdaui-entry-common-time.c
+++ b/libgda-ui/data-entries/gdaui-entry-common-time.c
@@ -1,6 +1,6 @@
/* gdaui-entry-common-time.c
*
- * Copyright (C) 2003 - 2007 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
@@ -177,13 +177,13 @@ gdaui_entry_common_time_init (GdauiEntryCommonTime *gdaui_entry_common_time)
}
/**
- * gdaui_entry_common_time_new
+ * gdaui_entry_common_time_new:
* @dh: the data handler to be used by the new widget
* @type: the requested data type (compatible with @dh)
*
- * Creates a new widget which is mainly a GtkEntry
+ * Creates a new data entry widget
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*/
GtkWidget *
gdaui_entry_common_time_new (GdaDataHandler *dh, GType type)
diff --git a/libgda-ui/data-entries/gdaui-entry-date.c b/libgda-ui/data-entries/gdaui-entry-date.c
index db53825..5f7173c 100644
--- a/libgda-ui/data-entries/gdaui-entry-date.c
+++ b/libgda-ui/data-entries/gdaui-entry-date.c
@@ -1,6 +1,6 @@
/* gdaui-entry-date.c
*
- * Copyright (C) 2003 - 2006 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
@@ -67,12 +67,12 @@ gdaui_entry_date_init (GdauiEntryDate * gdaui_entry_date)
}
/**
- * gdaui_entry_date_new
+ * gdaui_entry_date_new:
* @dh: the data handler to be used by the new widget
*
- * Creates a new widget which is mainly a GtkEntry
+ * Creates a new data entry widget
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*/
GtkWidget *
gdaui_entry_date_new (GdaDataHandler *dh)
diff --git a/libgda-ui/data-entries/gdaui-entry-none.c b/libgda-ui/data-entries/gdaui-entry-none.c
index 78115b1..81ae605 100644
--- a/libgda-ui/data-entries/gdaui-entry-none.c
+++ b/libgda-ui/data-entries/gdaui-entry-none.c
@@ -96,12 +96,12 @@ gdaui_entry_none_init (GdauiEntryNone * entry)
}
/**
- * gdaui_entry_none_new
+ * gdaui_entry_none_new:
* @type: the requested data type (compatible with @dh)
*
- * Creates a new widget which is mainly a GtkEntry
+ * Creates a new data entry widget
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*/
GtkWidget *
gdaui_entry_none_new (GType type)
diff --git a/libgda-ui/data-entries/gdaui-entry-number.c b/libgda-ui/data-entries/gdaui-entry-number.c
index f710ffc..ac79e7a 100644
--- a/libgda-ui/data-entries/gdaui-entry-number.c
+++ b/libgda-ui/data-entries/gdaui-entry-number.c
@@ -1,6 +1,6 @@
/* gdaui-entry-number.c
*
- * Copyright (C) 2009 Vivien Malerba
+ * Copyright (C) 2009 - 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
@@ -183,13 +183,13 @@ gdaui_entry_number_is_type_numeric (GType type)
}
/**
- * gdaui_entry_number_new
+ * gdaui_entry_number_new:
* @dh: the data handler to be used by the new widget
* @type: the requested data type (compatible with @dh)
*
- * Creates a new widget which is mainly a GtkEntry
+ * Creates a new data entry widget
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*/
GtkWidget *
gdaui_entry_number_new (GdaDataHandler *dh, GType type, const gchar *options)
diff --git a/libgda-ui/data-entries/gdaui-entry-shell.c b/libgda-ui/data-entries/gdaui-entry-shell.c
index b5e3156..bdd270c 100644
--- a/libgda-ui/data-entries/gdaui-entry-shell.c
+++ b/libgda-ui/data-entries/gdaui-entry-shell.c
@@ -74,7 +74,7 @@ struct _GdauiEntryShellPriv {
static GObjectClass *parent_class = NULL;
/**
- * gdaui_entry_shell_get_type
+ * gdaui_entry_shell_get_type:
*
* Register the GdauiEntryShell class on the GLib type system.
*
@@ -295,7 +295,7 @@ gdaui_entry_shell_get_property (GObject *object,
/**
- * gdaui_entry_shell_pack_entry
+ * gdaui_entry_shell_pack_entry:
* @shell: a #GdauiEntryShell object
* @main_widget: a #GtkWidget to pack into @shell
*
@@ -444,7 +444,7 @@ gdaui_entry_shell_refresh_attributes (GdauiEntryShell *shell)
}
/**
- * gdaui_entry_shell_refresh
+ * gdaui_entry_shell_refresh:
* @shell: the GdauiEntryShell widget to refresh
*
* Forces the shell to refresh its display (mainly the color of the
@@ -459,7 +459,7 @@ gdaui_entry_shell_refresh (GdauiEntryShell *shell)
}
/**
- * gdaui_entry_shell_set_unknown
+ * gdaui_entry_shell_set_unknown:
* @shell: the GdauiEntryShell widget to refresh
* @unknown: set to %TRUE if @shell's contents is unavailable and should not be modified
*
diff --git a/libgda-ui/data-entries/gdaui-entry-string.c b/libgda-ui/data-entries/gdaui-entry-string.c
index b02a675..5ff6b8a 100644
--- a/libgda-ui/data-entries/gdaui-entry-string.c
+++ b/libgda-ui/data-entries/gdaui-entry-string.c
@@ -189,13 +189,13 @@ gdaui_entry_string_init (GdauiEntryString *mgstr)
}
/**
- * gdaui_entry_string_new
+ * gdaui_entry_string_new:
* @dh: the data handler to be used by the new widget
* @type: the requested data type (compatible with @dh)
*
- * Creates a new widget which is mainly a GtkEntry
+ * Creates a new data entry widget
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*/
GtkWidget *
gdaui_entry_string_new (GdaDataHandler *dh, GType type, const gchar *options)
diff --git a/libgda-ui/data-entries/gdaui-entry-timestamp.c b/libgda-ui/data-entries/gdaui-entry-timestamp.c
index 81d02ba..a38e3a9 100644
--- a/libgda-ui/data-entries/gdaui-entry-timestamp.c
+++ b/libgda-ui/data-entries/gdaui-entry-timestamp.c
@@ -1,6 +1,6 @@
/* gdaui-entry-timestamp.c
*
- * Copyright (C) 2003 - 2006 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
@@ -67,12 +67,12 @@ gdaui_entry_timestamp_init (GdauiEntryTimestamp * gdaui_entry_timestamp)
}
/**
- * gdaui_entry_timestamp_new
+ * gdaui_entry_timestamp_new:
* @dh: the data handler to be used by the new widget
*
- * Creates a new widget which is mainly a GtkEntry
+ * Creates a new data entry widget
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*/
GtkWidget *
gdaui_entry_timestamp_new (GdaDataHandler *dh)
diff --git a/libgda-ui/data-entries/gdaui-entry-wrapper.c b/libgda-ui/data-entries/gdaui-entry-wrapper.c
index 3034fda..4df13a0 100644
--- a/libgda-ui/data-entries/gdaui-entry-wrapper.c
+++ b/libgda-ui/data-entries/gdaui-entry-wrapper.c
@@ -1,6 +1,6 @@
/* gdaui-entry-wrapper.c
*
- * Copyright (C) 2003 - 2009 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
@@ -331,7 +331,7 @@ gdaui_entry_wrapper_get_property (GObject *object,
}
/**
- * gdaui_entry_wrapper_contents_changed
+ * gdaui_entry_wrapper_contents_changed:
* @mgwrap: a #GdauiEntryWrapper widget
*
* Signals to @gwrap that the entry has changed
@@ -345,7 +345,7 @@ gdaui_entry_wrapper_contents_changed (GdauiEntryWrapper *mgwrap)
}
/**
- * gdaui_entry_wrapper_contents_activated
+ * gdaui_entry_wrapper_contents_activated:
* @mgwrap: a #GdauiEntryWrapper widget
*
* Signals to @gwrap that the entry has been activated (that is the user
diff --git a/libgda-ui/data-entries/gdaui-entry.c b/libgda-ui/data-entries/gdaui-entry.c
index c0fdaec..8613243 100644
--- a/libgda-ui/data-entries/gdaui-entry.c
+++ b/libgda-ui/data-entries/gdaui-entry.c
@@ -1,6 +1,6 @@
/* gdaui-entry.c
*
- * Copyright (C) 2009 Vivien Malerba <malerba gnome-db org>
+ * Copyright (C) 2009 - 2010 Vivien Malerba <malerba gnome-db org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -328,12 +328,12 @@ adjust_display (GdauiEntry *entry, gchar *existing_text)
/**
* gdaui_entry_new:
- * @prefix: a prefix (not modifiable) string, or %NULL
- * @suffix: a suffix (not modifiable) string, or %NULL
+ * @prefix: (allow-none): a prefix (not modifiable) string, or %NULL
+ * @suffix: (allow-none): a suffix (not modifiable) string, or %NULL
*
* Creates a new #GdauiEntry widget.
*
- * Returns: the newly created #GdauiEntry widget.
+ * Returns: (transfer full): the newly created #GdauiEntry widget.
*/
GtkWidget*
gdaui_entry_new (const gchar *prefix, const gchar *suffix)
@@ -345,7 +345,7 @@ gdaui_entry_new (const gchar *prefix, const gchar *suffix)
}
/**
- * gdaui_entry_set_max_length
+ * gdaui_entry_set_max_length:
* @entry: a #GdauiEntry.
* @max: the maximum length of the entry, or 0 for no maximum.
*
@@ -411,7 +411,7 @@ gdaui_entry_get_text (GdauiEntry *entry)
}
/**
- * gdaui_entry_set_text
+ * gdaui_entry_set_text:
* @entry: a #GdauiEntry widget
* @text: the text to set into @entry, or %NULL
*
@@ -449,7 +449,7 @@ gdaui_entry_set_text (GdauiEntry *entry, const gchar *text)
}
/**
- * gdaui_entry_set_prefix
+ * gdaui_entry_set_prefix:
* @entry: a #GdauiEntry widget
* @prefix: a prefix string
*
@@ -465,7 +465,7 @@ gdaui_entry_set_prefix (GdauiEntry *entry, const gchar *prefix)
}
/**
- * gdaui_entry_set_suffix
+ * gdaui_entry_set_suffix:
* @entry: a #GdauiEntry widget
* @suffix: a suffix string
*
@@ -482,7 +482,7 @@ gdaui_entry_set_suffix (GdauiEntry *entry, const gchar *suffix)
/**
- * gdaui_entry_set_width_chars
+ * gdaui_entry_set_width_chars:
* @entry: a #GdauiEntry widget
* @max_width: maximum width, or -1
*
diff --git a/libgda-ui/data-entries/gdaui-formatted-entry.c b/libgda-ui/data-entries/gdaui-formatted-entry.c
index 99c59d9..21775d7 100644
--- a/libgda-ui/data-entries/gdaui-formatted-entry.c
+++ b/libgda-ui/data-entries/gdaui-formatted-entry.c
@@ -1,6 +1,6 @@
/* gdaui-formatted-entry.c
*
- * Copyright (C) 2009 Vivien Malerba <malerba gnome-db org>
+ * Copyright (C) 2009 - 2010 Vivien Malerba <malerba gnome-db org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -457,7 +457,7 @@ gdaui_formatted_entry_assume_delete (GdauiEntry *entry, gint virt_start_pos, gin
* position in @mask is the space character (' '), then C will not interpreted as a writable format
* character as defined above. @mask does not be to have the same length as @format.
*
- * Returns: the newly created #GdauiFormattedEntry widget.
+ * Returns: (transfer full): the newly created #GdauiFormattedEntry widget.
*/
GtkWidget*
gdaui_formatted_entry_new (const gchar *format, const gchar *mask)
@@ -469,14 +469,14 @@ gdaui_formatted_entry_new (const gchar *format, const gchar *mask)
}
/**
- * gdaui_formatted_entry_get_text
+ * gdaui_formatted_entry_get_text:
* @entry: a #GdauiFormattedEntry widget
*
* Get @entry's contents. This function is similar to gdaui_get_text() except
* that it optionnally uses the information contained in @mask when gdaui_formatted_entry_new()
* was called to format the output differently.
*
- * Returns: a new string, or %NULL
+ * Returns: (transfer full): a new string, or %NULL
*/
gchar *
gdaui_formatted_entry_get_text (GdauiFormattedEntry *entry)
@@ -505,10 +505,10 @@ gdaui_formatted_entry_get_text (GdauiFormattedEntry *entry)
}
/**
- * gdaui_formatted_entry_set_insert_func
+ * gdaui_formatted_entry_set_insert_func:
* @entry: a #GdauiFormattedEntry widget
- * @insert_func: a #GdauiFormattedEntryInsertFunc, or %NULL
- * @data: a pointer which will be passed to @insert_func
+ * @insert_func: (allow-none): a #GdauiFormattedEntryInsertFunc, or %NULL
+ * @data: (allow-none): a pointer which will be passed to @insert_func
*
* Specifies that @entry should call @insert_func when the user wants to insert a char
* which is anot allowed, to perform other actions
diff --git a/libgda-ui/data-entries/gdaui-numeric-entry.c b/libgda-ui/data-entries/gdaui-numeric-entry.c
index a6946e0..7360b16 100644
--- a/libgda-ui/data-entries/gdaui-numeric-entry.c
+++ b/libgda-ui/data-entries/gdaui-numeric-entry.c
@@ -1,6 +1,6 @@
/* gdaui-numeric-entry.c
*
- * Copyright (C) 2009 Vivien Malerba <malerba gnome-db org>
+ * Copyright (C) 2009 - 2010 Vivien Malerba <malerba gnome-db org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@@ -668,7 +668,7 @@ gdaui_numeric_entry_assume_delete (GdauiEntry *entry, gint virt_start_pos, gint
*
* Creates a new #GdauiNumericEntry widget.
*
- * Returns: the newly created #GdauiNumericEntry widget.
+ * Returns: (transfer full): the newly created #GdauiNumericEntry widget.
*/
GtkWidget*
gdaui_numeric_entry_new (GType type)
@@ -680,12 +680,12 @@ gdaui_numeric_entry_new (GType type)
}
/**
- * gdaui_numeric_entry_get_text
+ * gdaui_numeric_entry_get_text:
* @entry: a #GdauiNumericEntry widget
*
* Get @entry's contents as a #GValue.
*
- * Returns: a new #GValue, or %NULL
+ * Returns: (transfer full): a new #GValue, or %NULL
*/
GValue *
gdaui_numeric_entry_get_value (GdauiNumericEntry *entry)
diff --git a/libgda-ui/data-entries/widget-embedder.c b/libgda-ui/data-entries/widget-embedder.c
index 953480a..965f6d3 100644
--- a/libgda-ui/data-entries/widget-embedder.c
+++ b/libgda-ui/data-entries/widget-embedder.c
@@ -418,6 +418,10 @@ widget_embedder_expose (GtkWidget *widget,
/**
* widget_embedder_set_valid
+ * @bin: a #WidgetEmbedder
+ * @valid: set to %TRUE for a valid entry
+ *
+ * Changes the validity aspect of @bin
*/
void
widget_embedder_set_valid (WidgetEmbedder *bin, gboolean valid)
diff --git a/libgda-ui/gdaui-basic-form.c b/libgda-ui/gdaui-basic-form.c
index 1f267e9..3a188fe 100644
--- a/libgda-ui/gdaui-basic-form.c
+++ b/libgda-ui/gdaui-basic-form.c
@@ -301,7 +301,7 @@ gdaui_basic_form_init (GdauiBasicForm * wid)
}
/**
- * gdaui_basic_form_new
+ * gdaui_basic_form_new:
* @data_set: a #GdaSet structure
*
* Creates a new #GdauiBasicForm widget using all the #GdaHolder objects provided in @data_set.
@@ -309,7 +309,7 @@ gdaui_basic_form_init (GdauiBasicForm * wid)
* The global layout is rendered using a table (a #GtkTable), and an entry is created for each
* node of @data_set.
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*
* Since: 4.2
*/
@@ -1529,13 +1529,13 @@ parameter_changed_cb (GdaHolder *param, SingleEntry *sentry)
}
/**
- * gdaui_basic_form_set_as_reference
+ * gdaui_basic_form_set_as_reference:
* @form: a #GdauiBasicForm widget
*
* Tells @form that the current values in the different entries are
* to be considered as the original values for all the entries; the immediate
* consequence is that any sub-sequent call to gdaui_basic_form_has_changed()
- * will return FALSE (of course until any entry is changed).
+ * will return %FALSE (of course until any entry is changed).
*
* Since: 4.2
*/
@@ -1586,12 +1586,12 @@ gdaui_basic_form_set_as_reference (GdauiBasicForm *form)
}
/**
- * gdaui_basic_form_is_valid
+ * gdaui_basic_form_is_valid:
* @form: a #GdauiBasicForm widget
*
* Tells if the form can be used as-is (if all the parameters do have some valid values)
*
- * Returns: TRUE if the form is valid
+ * Returns: %TRUE if the form is valid
*
* Since: 4.2
*/
@@ -1604,13 +1604,13 @@ gdaui_basic_form_is_valid (GdauiBasicForm *form)
}
/**
- * gdaui_basic_form_get_data_set
+ * gdaui_basic_form_get_data_set:
* @form: a #GdauiBasicForm widget
*
* Get a pointer to the #GdaSet object which
* is modified by @form
*
- * Returns: a pointer to the #GdaSet
+ * Returns: (transfer none): a pointer to the #GdaSet
*
* Since: 4.2
*/
@@ -1623,7 +1623,7 @@ gdaui_basic_form_get_data_set (GdauiBasicForm *form)
}
/**
- * gdaui_basic_form_has_changed
+ * gdaui_basic_form_has_changed:
* @form: a #GdauiBasicForm widget
*
* Tells if the form has had at least on entry changed since @form was created or
@@ -1677,7 +1677,7 @@ gdaui_basic_form_show_entry_actions (GdauiBasicForm *form, gboolean show_actions
}
/**
- * gdaui_basic_form_reset
+ * gdaui_basic_form_reset:
* @form: a #GdauiBasicForm widget
*
* Resets all the entries in the form to their
@@ -1715,7 +1715,7 @@ gdaui_basic_form_reset (GdauiBasicForm *form)
/**
- * gdaui_basic_form_entry_set_visible
+ * gdaui_basic_form_entry_set_visible:
* @form: a #GdauiBasicForm widget
* @param: a #GdaHolder object
* @show: set to %TRUE to show the data entry, and to %FALSE to hide it
@@ -1778,7 +1778,7 @@ gdaui_basic_form_entry_set_visible (GdauiBasicForm *form, GdaHolder *param, gboo
}
/**
- * gdaui_basic_form_entry_grab_focus
+ * gdaui_basic_form_entry_grab_focus:
* @form: a #GdauiBasicForm widget
* @param: a #GdaHolder object
*
@@ -1800,9 +1800,9 @@ gdaui_basic_form_entry_grab_focus (GdauiBasicForm *form, GdaHolder *param)
}
/**
- * gdaui_basic_form_entry_set_editable
+ * gdaui_basic_form_entry_set_editable:
* @form: a #GdauiBasicForm widget
- * @holder: a #GdaHolder object; or %NULL
+ * @holder: (allow-none): a #GdaHolder object; or %NULL
* @editable: %TRUE if corresponding data entry must be editable
*
* Sets the #GdauiDataEntry in @form which corresponds to the
@@ -1860,7 +1860,7 @@ gdaui_basic_form_set_entries_auto_default (GdauiBasicForm *form, gboolean auto_d
}
/**
- * gdaui_basic_form_set_entries_to_default
+ * gdaui_basic_form_set_entries_to_default:
* @form: a #GdauiBasicForm widget
*
* For each entry in the form, sets it to a default value if it is possible to do so.
@@ -1928,13 +1928,13 @@ get_single_entry_for_id (GdauiBasicForm *form, const gchar *id)
}
/**
- * gdaui_basic_form_get_entry_widget
+ * gdaui_basic_form_get_entry_widget:
* @form: a #GdauiBasicForm widget
* @param: a #GdaHolder object
*
* Get the #GdauiDataEntry in @form which corresponds to the param parameter.
*
- * Returns: the requested widget, or %NULL if not found
+ * Returns: (transfer none): the requested widget, or %NULL if not found
*
* Since: 4.2
*/
@@ -1953,13 +1953,13 @@ gdaui_basic_form_get_entry_widget (GdauiBasicForm *form, GdaHolder *param)
}
/**
- * gdaui_basic_form_get_label_widget
+ * gdaui_basic_form_get_label_widget:
* @form: a #GdauiBasicForm widget
* @param: a #GdaHolder object
*
* Get the label in @form which corresponds to the param parameter.
*
- * Returns: the requested widget, or %NULL if not found
+ * Returns: (transfer none): the requested widget, or %NULL if not found
*
* Since: 4.2
*/
@@ -1978,11 +1978,11 @@ gdaui_basic_form_get_label_widget (GdauiBasicForm *form, GdaHolder *param)
}
/**
- * gdaui_basic_form_new_in_dialog
+ * gdaui_basic_form_new_in_dialog:
* @data_set: a #GdaSet 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 #GdauiBasicForm widget in the same way as gdaui_basic_form_new()
* and puts it into a #GtkDialog widget. The returned dialog has the "Ok" and "Cancel" buttons
@@ -1991,7 +1991,7 @@ gdaui_basic_form_get_label_widget (GdauiBasicForm *form, GdaHolder *param)
* The #GdauiBasicForm widget is attached to the dialog using the user property
* "form".
*
- * Returns: the new #GtkDialog widget
+ * Returns: (transfer full): the new #GtkDialog widget
*
* Since: 4.2
*/
@@ -2068,7 +2068,7 @@ form_holder_changed (GdauiBasicForm *form, GdaHolder *param, gboolean is_user_mo
}
/**
- * gdaui_basic_form_set_layout_from_file
+ * gdaui_basic_form_set_layout_from_file:
* @form: a #GdauiBasicForm
* @file_name: XML file name to use
* @form_name: the name of the form to use, in @file_name
@@ -2137,14 +2137,14 @@ gdaui_basic_form_set_layout_from_file (GdauiBasicForm *form, const gchar *file_n
}
/**
- * gdaui_basic_form_get_place_holder
+ * gdaui_basic_form_get_place_holder:
* @form: a #GdauiBasicForm
* @placeholder_id: the name of the requested place holder
*
* Retreives a pointer to a place holder widget. This feature is only available if a specific
* layout has been defined for @form using gdaui_basic_form_set_layout_from_file().
*
- * Returns: a pointer to the requested place holder, or %NULL if not found
+ * Returns: (transfer none): a pointer to the requested place holder, or %NULL if not found
*
* Since: 4.2
*/
@@ -2160,7 +2160,7 @@ gdaui_basic_form_get_place_holder (GdauiBasicForm *form, const gchar *placeholde
}
/**
- * gdaui_basic_form_add_to_size_group
+ * gdaui_basic_form_add_to_size_group:
* @form: a #GdauiBasicForm
* @size_group: a #GtkSizeGroup object
* @part: specifies which widgets in @form are concerned
@@ -2201,7 +2201,7 @@ gdaui_basic_form_add_to_size_group (GdauiBasicForm *form, GtkSizeGroup *size_gro
}
/**
- * gdaui_basic_form_remove_from_size_group
+ * gdaui_basic_form_remove_from_size_group:
* @form: a #GdauiBasicForm
* @size_group: a #GtkSizeGroup object
* @part: specifies which widgets in @form are concerned
diff --git a/libgda-ui/gdaui-cloud.c b/libgda-ui/gdaui-cloud.c
index 31956d7..0250bd8 100644
--- a/libgda-ui/gdaui-cloud.c
+++ b/libgda-ui/gdaui-cloud.c
@@ -1,6 +1,6 @@
/* gdaui-cloud.c
*
- * Copyright (C) 2009 Vivien Malerba
+ * Copyright (C) 2009 - 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
@@ -384,12 +384,12 @@ gdaui_cloud_init (GdauiCloud *cloud)
}
/**
- * gdaui_cloud_new
+ * gdaui_cloud_new:
* @model: a #GdaDataModel
*
* Creates a new #GdauiCloud widget suitable to display the data in @model
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*
* Since: 4.2
*/
@@ -536,7 +536,7 @@ gdaui_cloud_get_property (GObject *object,
}
/**
- * gdaui_cloud_set_selection_mode
+ * gdaui_cloud_set_selection_mode:
* @cloud: a #GdauiCloud widget
* @mode: the desired selection mode
*
@@ -1023,9 +1023,9 @@ text_tag_table_foreach_cb (GtkTextTag *tag, FilterData *fdata)
}
/**
- * gdaui_cloud_filter
+ * gdaui_cloud_filter:
* @cloud: a #GdauiCloud widget
- * @filter: the filter to use, or %NULL to remove any filter
+ * @filter: (allow-none): the filter to use, or %NULL to remove any filter
*
* Filters the elements displayed in @cloud, by altering their color.
*
@@ -1054,12 +1054,12 @@ find_entry_changed_cb (GtkWidget *entry, GdauiCloud *cloud)
}
/**
- * gdaui_cloud_create_filter_widget
+ * gdaui_cloud_create_filter_widget:
* @cloud: a #GdauiCloud widget
*
* Creates a search widget linked directly to modify @cloud's appearance.
*
- * Returns: a new widget
+ * Returns: (transfer full): a new widget
*
* Since: 4.2
*/
@@ -1084,10 +1084,10 @@ gdaui_cloud_create_filter_widget (GdauiCloud *cloud)
}
/**
- * gdaui_cloud_set_weight_func
+ * gdaui_cloud_set_weight_func:
* @cloud: a #GdauiCloud widget
- * @func: a #GdauiCloudWeightFunc function which computes weights, or %NULL to unset
- * @data: a pointer to pass as last argument of @func each time it is called
+ * @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
*
* 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 b3549b9..13874b0 100644
--- a/libgda-ui/gdaui-combo.c
+++ b/libgda-ui/gdaui-combo.c
@@ -1,6 +1,6 @@
/* GNOME DB library
*
- * Copyright (C) 1999 - 2009 The Free Software Foundation
+ * Copyright (C) 1999 - 2010 The Free Software Foundation
*
* AUTHORS:
* Rodrigo Moya <rodrigo gnome-db org>
@@ -297,11 +297,11 @@ gdaui_combo_finalize (GObject *object)
}
/**
- * gdaui_combo_new
+ * gdaui_combo_new:
*
* Create a new GdauiCombo widget.
*
- * Returns: the newly-created widget.
+ * Returns: (transfer full): the newly-created widget.
*
* Since: 4.2
*/
@@ -316,7 +316,7 @@ gdaui_combo_new ()
}
/**
- * gdaui_combo_new_with_model
+ * gdaui_combo_new_with_model:
* @model: a #GdaDataModel object.
* @n_cols: number of columns in the model to be shown
* @cols_index: an array of columns to be shown, its size must be @n_cols
@@ -324,7 +324,7 @@ gdaui_combo_new ()
* Create a new GdauiCombo widget with a model. See gdaui_combo_set_model() for
* more information about the @n_cols and @cols_index usage.
*
- * Returns: the newly-created widget.
+ * Returns: (transfer full): the newly-created widget.
*
* Since: 4.2
*/
@@ -345,18 +345,18 @@ static void cell_layout_data_func (GtkCellLayout *cell_layout, GtkCellRenderer *
GtkTreeModel *tree_model, GtkTreeIter *iter, GdauiCombo *combo);
/**
- * gdaui_combo_set_model
+ * gdaui_combo_set_model:
* @combo: a #GdauiCombo widget.
* @model: a #GdaDataModel object.
* @n_cols: number of columns in the model to be shown
- * @cols_index: an array of columns to be shown, its size must be @n_cols
+ * @cols_index: (array length=n_cols): an array of columns to be shown, its size must be @n_cols
*
* Makes @combo display data stored in @model (makes the
* combo widget refresh its list of values and display the values contained
* in the model). A NULL @model will make the combo empty
* and disassociate the previous model, if any.
*
- * if @n_cols is 0, then all the columns of @model will be displayed in @combo.
+ * if @n_cols is %0, then all the columns of @model will be displayed in @combo.
*
* Since: 4.2
*/
@@ -625,7 +625,7 @@ _gdaui_combo_get_selected_ext (GdauiCombo *combo, gint n_cols, gint *cols_index)
}
/**
- * gdaui_combo_add_null
+ * gdaui_combo_add_null:
* @combo: a #GdauiCombo widget
* @add_null: set to %TRUE to add a NULL value to the combo box
*
@@ -643,7 +643,7 @@ gdaui_combo_add_null (GdauiCombo *combo, gboolean add_null)
}
/**
- * gdaui_combo_is_null_selected
+ * gdaui_combo_is_null_selected:
* @combo: a #GdauiCombo widget
*
* Tell if the currently selected entry represents the "undefined choice" entry.
diff --git a/libgda-ui/gdaui-data-entry.c b/libgda-ui/gdaui-data-entry.c
index 7c00024..2dbf139 100644
--- a/libgda-ui/gdaui-data-entry.c
+++ b/libgda-ui/gdaui-data-entry.c
@@ -130,7 +130,7 @@ gdaui_data_entry_iface_init (gpointer g_class)
}
/**
- * gdaui_data_entry_set_value_type
+ * gdaui_data_entry_set_value_type:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
* @type: the #GType of the data to be displayed
*
@@ -150,7 +150,7 @@ gdaui_data_entry_set_value_type (GdauiDataEntry *de, GType type)
/**
- * gdaui_data_entry_get_value_type
+ * gdaui_data_entry_get_value_type:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
*
* Fetch the type of data the GdauiDataEntry handles
@@ -170,9 +170,9 @@ gdaui_data_entry_get_value_type (GdauiDataEntry *de)
}
/**
- * gdaui_data_entry_set_value
+ * gdaui_data_entry_set_value:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
- * @value: a #GValue, or %NULL
+ * @value: (allow-none): a #GValue, or %NULL
*
* Push a value into the #GdauiDataEntry. The value parameter must either be:
* <itemizedlist>
@@ -194,7 +194,7 @@ gdaui_data_entry_set_value (GdauiDataEntry *de, const GValue *value)
}
/**
- * gdaui_data_entry_get_value
+ * gdaui_data_entry_get_value:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
*
* Fetch the value held in the GdauiDataEntry widget. If the value is set to NULL,
@@ -202,7 +202,7 @@ gdaui_data_entry_set_value (GdauiDataEntry *de, const GValue *value)
* then the returned value is of type GDA_TYPE_NULL or is the default value if it
* has been provided to the widget (and is of the same type as the one provided by @de).
*
- * Returns: a new #GValue
+ * Returns: (transfer none): a new #GValue
*
* Since: 4.2
*/
@@ -218,9 +218,9 @@ gdaui_data_entry_get_value (GdauiDataEntry *de)
}
/**
- * gdaui_data_entry_content_is_valid
+ * gdaui_data_entry_content_is_valid:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
- * @error: a place to store an error, or %NULL
+ * @error: (allow-none): a place to store an error, or %NULL
*
* Tests the validity of @de's contents. The validity is a determined from:
* <itemizedlist>
@@ -244,9 +244,9 @@ gdaui_data_entry_content_is_valid (GdauiDataEntry *de, GError **error)
/**
- * gdaui_data_entry_set_reference_value
+ * gdaui_data_entry_set_reference_value:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
- * @value: a #GValue, or %NULL
+ * @value: (allow-none): a #GValue, or %NULL
*
* Push a value into the GdauiDataEntry in the same way as gdaui_data_entry_set_value() but
* also sets this value as the reference value.
@@ -263,7 +263,7 @@ gdaui_data_entry_set_reference_value (GdauiDataEntry *de, const GValue *value)
}
/**
- * gdaui_data_entry_set_reference_current
+ * gdaui_data_entry_set_reference_current:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
*
* Tells that the current value in @de is to be considered as the reference value
@@ -284,12 +284,12 @@ gdaui_data_entry_set_reference_current (GdauiDataEntry *de)
/**
- * gdaui_data_entry_get_reference_value
+ * gdaui_data_entry_get_reference_value:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
*
* Fetch the reference value held in the #GdauiDataEntry widget
*
- * Returns: the #GValue (not modifiable)
+ * Returns: (transfer none): the #GValue (not modifiable)
*
* Since: 4.2
*/
@@ -306,9 +306,9 @@ gdaui_data_entry_get_reference_value (GdauiDataEntry *de)
/**
- * gdaui_data_entry_set_default_value
+ * gdaui_data_entry_set_default_value:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
- * @value: a #GValue, or %NULL
+ * @value: (allow-none): a #GValue, or %NULL
*
* Sets the default value for the GdauiDataEntry which gets displayed when the
* user forces the default value. If it is not set then it is set to type GDA_TYPE_NULL.
@@ -331,12 +331,12 @@ gdaui_data_entry_set_default_value (GdauiDataEntry *de, const GValue *value)
}
/**
- * gdaui_data_entry_set_attributes
+ * gdaui_data_entry_set_attributes:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
* @attrs: the attributes to set (OR'ed between them)
* @mask: the mask corresponding to the considered attributes
*
- * Sets the parameters of the GdauiDataEntry. Only the attributes corresponding to the
+ * Sets the parameters of the #GdauiDataEntry. Only the attributes corresponding to the
* mask are set, the other ones are ignored.
*
* Since: 4.2
@@ -351,7 +351,7 @@ gdaui_data_entry_set_attributes (GdauiDataEntry *de, GdaValueAttribute attrs, Gd
}
/**
- * gdaui_data_entry_get_attributes
+ * gdaui_data_entry_get_attributes:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
*
* Retrieves the parameters of the GdauiDataEntry widget.
@@ -373,12 +373,12 @@ gdaui_data_entry_get_attributes (GdauiDataEntry *de)
/**
- * gdaui_data_entry_get_handler
+ * gdaui_data_entry_get_handler:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
*
* Fetch the GdaDataHandler the GdauiDataEntry is using
*
- * Returns: the GdaDataHandler object
+ * Returns: (transfer none): the GdaDataHandler object
*
* Since: 4.2
*/
@@ -394,14 +394,14 @@ gdaui_data_entry_get_handler (GdauiDataEntry *de)
}
/**
- * gdaui_data_entry_can_expand
+ * gdaui_data_entry_can_expand:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
* @horiz: %TRUE to query horizontal expansion requirements, or %FALSE for vertical
*
* Used for the layout of #GdaDataEntry widgets in containers: queries if @de requires
* horizontal or vertical expansion, depending on @horiz
*
- * Returns: TRUE if the widget requires expansion
+ * Returns: %TRUE if the widget requires expansion
*
* Since: 4.2
*/
@@ -417,7 +417,7 @@ gdaui_data_entry_can_expand (GdauiDataEntry *de, gboolean horiz)
}
/**
- * gdaui_data_entry_set_editable
+ * gdaui_data_entry_set_editable:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
* @editable: set to %TRUE to have an editable data entry
*
@@ -437,7 +437,7 @@ gdaui_data_entry_set_editable (GdauiDataEntry *de, gboolean editable)
}
/**
- * gdaui_data_entry_get_editable
+ * gdaui_data_entry_get_editable:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
*
* Tells if @de can be edited by the user
@@ -461,7 +461,7 @@ gdaui_data_entry_get_editable (GdauiDataEntry *de)
}
/**
- * gdaui_data_entry_grab_focus
+ * gdaui_data_entry_grab_focus:
* @de: a #GtkWidget object which implements the #GdauiDataEntry interface
*
* Makes @de grab the focus for the window it's in
diff --git a/libgda-ui/gdaui-data-filter.c b/libgda-ui/gdaui-data-filter.c
index e133cac..8d9b742 100644
--- a/libgda-ui/gdaui-data-filter.c
+++ b/libgda-ui/gdaui-data-filter.c
@@ -1,6 +1,6 @@
/* gdaui-data-filter.c
*
- * Copyright (C) 2007 - 2009 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
@@ -246,13 +246,13 @@ gdaui_data_filter_init (GdauiDataFilter * wid)
}
/**
- * gdaui_data_filter_new
+ * gdaui_data_filter_new:
* @data_widget: a widget implementing the #GdauiDataProxy interface
*
* Creates a new #GdauiDataFilter widget suitable to change the filter expression
* for @data_widget's displayed rows
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*
* Since: 4.2
*/
diff --git a/libgda-ui/gdaui-data-proxy-info.c b/libgda-ui/gdaui-data-proxy-info.c
index 1a444cd..070f69f 100644
--- a/libgda-ui/gdaui-data-proxy-info.c
+++ b/libgda-ui/gdaui-data-proxy-info.c
@@ -1,6 +1,6 @@
/* gdaui-data-proxy-info.c
*
- * Copyright (C) 2006 - 2009 Vivien Malerba <malerba gnome-db org>
+ * Copyright (C) 2006 - 2010 Vivien Malerba <malerba gnome-db org>
*
* This Library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public License as
@@ -132,13 +132,13 @@ gdaui_data_proxy_info_init (GdauiDataProxyInfo *wid)
}
/**
- * gdaui_data_proxy_info_new
+ * gdaui_data_proxy_info_new:
* @data_proxy: a widget implementing the #GdauiDataProxy interface
* @flags: OR'ed values, specifying what to display in the new widget
*
* Creates a new #GdauiDataProxyInfo widget suitable to display information about @data_proxy
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*
* Since: 4.2
*/
diff --git a/libgda-ui/gdaui-data-proxy.c b/libgda-ui/gdaui-data-proxy.c
index 6c4d2f9..65879ae 100644
--- a/libgda-ui/gdaui-data-proxy.c
+++ b/libgda-ui/gdaui-data-proxy.c
@@ -1,6 +1,6 @@
/* gdaui-data-widget.c
*
- * Copyright (C) 2004 - 2009 Vivien Malerba <malerba gnome-db org>
+ * Copyright (C) 2004 - 2010 Vivien Malerba <malerba gnome-db org>
*
* This Library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public License as
@@ -80,12 +80,12 @@ gdaui_data_proxy_iface_init (gpointer g_class)
}
/**
- * gdaui_data_proxy_get_proxy
+ * gdaui_data_proxy_get_proxy:
* @iface: an object which implements the #GdauiDataProxy interface
*
* Get a pointer to the #GdaDataProxy being used by @iface
*
- * Returns: a #GdaDataProxy pointer
+ * Returns: (transfer none): a #GdaDataProxy pointer
*
* Since: 4.2
*/
@@ -101,7 +101,7 @@ gdaui_data_proxy_get_proxy (GdauiDataProxy *iface)
}
/**
- * gdaui_data_proxy_column_set_editable
+ * gdaui_data_proxy_column_set_editable:
* @iface: an object which implements the #GdauiDataProxy interface
* @column: column number of the data
* @editable: set to %TRUE to make the column editable
@@ -121,10 +121,10 @@ gdaui_data_proxy_column_set_editable (GdauiDataProxy *iface, gint column, gboole
}
/**
- * gdaui_data_proxy_column_show_actions
+ * gdaui_data_proxy_column_show_actions:
* @iface: an object which implements the #GdauiDataProxy interface
* @column: column number of the data, or -1 to apply the setting to all the columns
- * @show_actions:
+ * @show_actions: set to %TRUE if the actions menu must be shown
*
* Sets if the data entry in the @iface widget at @column (in the data model @iface operates on) must show its
* actions menu or not.
@@ -141,7 +141,7 @@ gdaui_data_proxy_column_show_actions (GdauiDataProxy *iface, gint column, gboole
}
/**
- * gdaui_data_proxy_get_actions_group
+ * gdaui_data_proxy_get_actions_group:
* @iface: an object which implements the #GdauiDataProxy interface
*
* Each widget imlplementing the #GdauiDataProxy interface provides actions. Actions can be triggered
@@ -157,7 +157,7 @@ gdaui_data_proxy_column_show_actions (GdauiDataProxy *iface, gint column, gboole
* "ActionNextChunck", "ActionLastChunck".</para></listitem>
* <listitem><para>Filtering: "ActionFilter"</para></listitem></itemizedlist>
*
- * Returns: the #GtkActionGroup with all the possible actions on the widget.
+ * Returns: (transfer none): the #GtkActionGroup with all the possible actions on the widget.
*
* Since: 4.2
*/
@@ -172,7 +172,7 @@ gdaui_data_proxy_get_actions_group (GdauiDataProxy *iface)
}
/**
- * gdaui_data_proxy_perform_action
+ * gdaui_data_proxy_perform_action:
* @iface: an object which implements the #GdauiDataProxy interface
* @action: a #GdauiAction action
*
@@ -248,7 +248,7 @@ gdaui_data_proxy_perform_action (GdauiDataProxy *iface, GdauiAction action)
}
/**
- * gdaui_data_proxy_set_write_mode
+ * gdaui_data_proxy_set_write_mode:
* @iface: an object which implements the #GdauiDataProxy interface
* @mode: the requested #GdauiDataProxyWriteMode mode
*
@@ -271,7 +271,7 @@ gdaui_data_proxy_set_write_mode (GdauiDataProxy *iface, GdauiDataProxyWriteMode
}
/**
- * gdaui_data_proxy_get_write_mode
+ * gdaui_data_proxy_get_write_mode:
* @iface: an object which implements the #GdauiDataProxy interface
*
* Get the way the modifications stored in the #GdaDataProxy used internally by @iface are written back to
diff --git a/libgda-ui/gdaui-data-selector.c b/libgda-ui/gdaui-data-selector.c
index 5bfff25..b5a3952 100644
--- a/libgda-ui/gdaui-data-selector.c
+++ b/libgda-ui/gdaui-data-selector.c
@@ -1,6 +1,6 @@
/* gdaui-data-selector.c
*
- * Copyright (C) 2009 Vivien Malerba <malerba gnome-db org>
+ * Copyright (C) 2009 - 2010 Vivien Malerba <malerba gnome-db org>
*
* This Library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public License as
@@ -81,14 +81,14 @@ gdaui_data_selector_iface_init (gpointer g_class)
}
/**
- * gdaui_data_selector_get_model
+ * gdaui_data_selector_get_model:
* @iface: an object which implements the #GdauiDataSelector interface
*
* Queries the #GdaDataModel from which the data displayed by the widget implementing @iface
* are. Beware that the returned data model may be different than the one used when the
* widget was created in case it uses a #GdaDataProxy.
*
- * Returns: the #GdaDataModel
+ * Returns: (transfer none): the #GdaDataModel
*
* Since: 4.2
*/
@@ -103,7 +103,7 @@ gdaui_data_selector_get_model (GdauiDataSelector *iface)
}
/**
- * gdaui_data_selector_set_model
+ * gdaui_data_selector_set_model:
* @iface: an object which implements the #GdauiDataSelector interface
* @model: a #GdaDataModel to use
*
@@ -122,7 +122,7 @@ gdaui_data_selector_set_model (GdauiDataSelector *iface, GdaDataModel *model)
}
/**
- * gdaui_data_selector_get_selected_rows
+ * gdaui_data_selector_get_selected_rows:
* @iface: an object which implements the #GdauiDataSelector interface
*
* Gat an array of selected rows. If no row is selected, the the returned value is %NULL.
@@ -132,8 +132,7 @@ gdaui_data_selector_set_model (GdauiDataSelector *iface, GdaDataModel *model)
* uses a #GdaDataProxy (as is the case for example for the #GdauiRawForm, #GdauiForm, #GdauiRawGrid
* and #GdauiGrid).
*
- * Returns: an array of #gint values, one for each selected row. Use g_array_free() when
- * finished (passing %TRUE as the last argument)
+ * Returns: (transfer full): an array of #gint values, one for each selected row. Use g_array_free() when finished (passing %TRUE as the last argument)
*
* Since: 4.2
*/
@@ -149,7 +148,7 @@ gdaui_data_selector_get_selected_rows (GdauiDataSelector *iface)
}
/**
- * gdaui_data_selector_select_row
+ * gdaui_data_selector_select_row:
* @iface: an object which implements the #GdauiDataSelector interface
* @row: the row to select
*
@@ -176,7 +175,7 @@ gdaui_data_selector_select_row (GdauiDataSelector *iface, gint row)
}
/**
- * gdaui_data_selector_unselect_row
+ * gdaui_data_selector_unselect_row:
* @iface: an object which implements the #GdauiDataSelector interface
* @row: the row to unselect
*
@@ -197,9 +196,9 @@ gdaui_data_selector_unselect_row (GdauiDataSelector *iface, gint row)
}
/**
- * gdaui_data_selector_set_column_visible
+ * gdaui_data_selector_set_column_visible:
* @iface: an object which implements the #GdauiDataSelector interface
- * @column: a column number, starting at 0
+ * @column: a column number, starting at %0
* @visible: required visibility of the data in the @column column
*
* Shows or hides the data at column @column
@@ -216,7 +215,7 @@ gdaui_data_selector_set_column_visible (GdauiDataSelector *iface, gint column, g
}
/**
- * gdaui_data_selector_get_data_set
+ * gdaui_data_selector_get_data_set:
* @iface: an object which implements the #GdauiDataSelector interface
*
* Get the #GdaDataModelIter object represented the current selected row in @iface. This
@@ -226,7 +225,7 @@ gdaui_data_selector_set_column_visible (GdauiDataSelector *iface, gint column, g
* Note that the returned #GdaDataModelIter is actually an iterator iterating on the #GdaDataModel
* returned by the gdaui_data_selector_get_model() method.
*
- * Returns: a pointer to a #GdaDataModelIter object, or %NULL
+ * Returns: (transfer none): a pointer to a #GdaDataModelIter object, or %NULL
*
* Since: 4.2
*/
diff --git a/libgda-ui/gdaui-data-store.c b/libgda-ui/gdaui-data-store.c
index 5c8cd94..250bd09 100644
--- a/libgda-ui/gdaui-data-store.c
+++ b/libgda-ui/gdaui-data-store.c
@@ -1,6 +1,6 @@
/* gdaui-data-store.c
*
- * Copyright (C) 2005 - 2009 Vivien Malerba <malerba gnome-db org>
+ * Copyright (C) 2005 - 2010 Vivien Malerba <malerba gnome-db org>
*
* This Library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public License as
@@ -324,12 +324,12 @@ gdaui_data_store_get_property (GObject *object,
}
/**
- * gdaui_data_store_new
+ * gdaui_data_store_new:
* @model: a #GdaDataModel object
*
* Creates a #GtkTreeModel interface with a #GdaDataModel
*
- * Returns: the new object
+ * Returns: (transfer full): the new object
*
* Since: 4.2
*/
@@ -345,7 +345,7 @@ gdaui_data_store_new (GdaDataModel *model)
}
/**
- * gdaui_data_store_set_value
+ * gdaui_data_store_set_value:
* @store: a #GdauiDataStore object
* @iter: the considered row
* @col: the data model column
@@ -353,7 +353,7 @@ gdaui_data_store_new (GdaDataModel *model)
*
* Stores a value in the @store data model.
*
- * Returns: TRUE on success
+ * Returns: %TRUE on success
*
* Since: 4.2
*/
@@ -412,7 +412,7 @@ gdaui_data_store_set_value (GdauiDataStore *store, GtkTreeIter *iter,
}
/**
- * gdaui_data_store_delete
+ * gdaui_data_store_delete:
* @store: a #GdauiDataStore object
* @iter: the considered row
*
@@ -437,7 +437,7 @@ gdaui_data_store_delete (GdauiDataStore *store, GtkTreeIter *iter)
/**
- * gdaui_data_store_undelete
+ * gdaui_data_store_undelete:
* @store: a #GdauiDataStore object
* @iter: the considered row
*
@@ -462,13 +462,13 @@ gdaui_data_store_undelete (GdauiDataStore *store, GtkTreeIter *iter)
/**
- * gdaui_data_store_append
+ * gdaui_data_store_append:
* @store: a #GdauiDataStore object
* @iter: an unset #GtkTreeIter to set to the appended row
*
* Appends a new row.
*
- * Returns: TRUE if no error occurred
+ * Returns: %TRUE if no error occurred
*
* Since: 4.2
*/
@@ -494,10 +494,10 @@ gdaui_data_store_append (GdauiDataStore *store, GtkTreeIter *iter)
}
/**
- * gdaui_data_store_get_proxy
+ * gdaui_data_store_get_proxy:
* @store: a #GdauiDataStore object
*
- * Returns: the internal #GdaDataProxy being used by @store
+ * Returns: (transfer none): the internal #GdaDataProxy being used by @store
*
* Since: 4.2
*/
@@ -511,7 +511,7 @@ gdaui_data_store_get_proxy (GdauiDataStore *store)
}
/**
- * gdaui_data_store_get_row_from_iter
+ * gdaui_data_store_get_row_from_iter:
* @store: a #GdauiDataStore object
* @iter: a valid #GtkTreeIter
*
@@ -533,9 +533,9 @@ gdaui_data_store_get_row_from_iter (GdauiDataStore *store, GtkTreeIter *iter)
}
/**
- * gdaui_data_store_get_iter_from_values
+ * gdaui_data_store_get_iter_from_values:
* @store: a #GdauiDataStore object
- * @iter: an unset #GtkTreeIter to set to the requested row
+ * @iter: (out): an unset #GtkTreeIter to set to the requested row
* @values: a list of #GValue values
* @cols_index: an array of #gint containing the column number to match each value of @values
*
@@ -544,7 +544,7 @@ gdaui_data_store_get_row_from_iter (GdauiDataStore *store, GtkTreeIter *iter)
*
* NOTE: the @cols_index array MUST contain a column index for each value in @values
*
- * Returns: TRUE if the row has been identified @iter was set
+ * Returns: %TRUE if the row has been identified @iter was set
*
* Since: 4.2
*/
diff --git a/libgda-ui/gdaui-form.c b/libgda-ui/gdaui-form.c
index bb38310..58cdb4f 100644
--- a/libgda-ui/gdaui-form.c
+++ b/libgda-ui/gdaui-form.c
@@ -1,6 +1,6 @@
/* gdaui-form.c
*
- * Copyright (C) 2002 - 2009 Vivien Malerba
+ * Copyright (C) 2002 - 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
@@ -200,13 +200,12 @@ gdaui_form_init (GdauiForm *form)
}
/**
- * gdaui_form_new
+ * gdaui_form_new:
* @model: a #GdaDataModel
*
* Creates a new #GdauiForm widget suitable to display the data in @model
*
- * Returns: the new widget
- *
+ * Returns: (transfer full): the new widget
*
* Since: 4.2
*/
diff --git a/libgda-ui/gdaui-grid.c b/libgda-ui/gdaui-grid.c
index 039c79c..72b035c 100644
--- a/libgda-ui/gdaui-grid.c
+++ b/libgda-ui/gdaui-grid.c
@@ -1,6 +1,6 @@
/* gdaui-grid.c
*
- * Copyright (C) 2002 - 2009 Vivien Malerba
+ * Copyright (C) 2002 - 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
@@ -194,12 +194,12 @@ gdaui_grid_init (GdauiGrid *grid)
}
/**
- * gdaui_grid_new
+ * gdaui_grid_new:
* @model: a #GdaDataModel
*
* Creates a new #GdauiGrid widget suitable to display the data in @model
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*
* Since: 4.2
*/
@@ -277,9 +277,12 @@ gdaui_grid_get_property (GObject *object,
}
/**
- * gdaui_grid_set_sample_size
+ * gdaui_grid_set_sample_size:
* @grid: a #GdauiGrid widget
- * @sample_size:
+ * @sample_size: the size of the sample displayed in @grid
+ *
+ * Sets the size of each chunk of data to display: the maximum number of rows which
+ * can be displayed at a time. See gdaui_raw_grid_set_sample_size() and gda_data_proxy_set_sample_size()
*
* Since: 4.2
*/
diff --git a/libgda-ui/gdaui-init.c b/libgda-ui/gdaui-init.c
index 49afa82..3437d1a 100644
--- a/libgda-ui/gdaui-init.c
+++ b/libgda-ui/gdaui-init.c
@@ -1,5 +1,5 @@
/* GNOME DB library
- * Copyright (C) 1999 - 2009 The GNOME Foundation.
+ * Copyright (C) 1999 - 2010 The GNOME Foundation.
*
* AUTHORS:
* Rodrigo Moya <rodrigo gnome-db org>
@@ -48,7 +48,7 @@ GHashTable *gdaui_plugins_hash = NULL; /* key = plugin name, value = GdauiPlugin
/**
- * gdaui_init
+ * gdaui_init:
*
* Initialization of the libgda-ui library, must be called before any usage of the library.
*
@@ -89,7 +89,7 @@ gdaui_init (void)
}
/**
- * gdaui_new_data_entry
+ * gdaui_new_data_entry:
* @type: a #GType
* @plugin_name: the name of an entry plugin, or %NULL
*
@@ -100,7 +100,7 @@ gdaui_init (void)
* @plugin_name format is interpreted as two parts: <plugin name>:<plugin options>, and
* if the plugins has no option, then the ":<plugin options>" part may be omitted.
*
- * Returns: a new #GdauiDataEntry widget, _NEVER_ %NULL
+ * Returns: (transfer full): a new #GdauiDataEntry widget, _NEVER_ %NULL
*/
GdauiDataEntry *
gdaui_new_data_entry (GType type, const gchar *plugin_name)
@@ -236,7 +236,7 @@ _gdaui_new_cell_renderer (GType type, const gchar *plugin_name)
}
/**
- * gdaui_plugin_declare
+ * gdaui_plugin_declare:
* @plugin: a pointer to a structure filled to describe the new plugin
*
* Adds a new plugin which will be used by the forms and grids. The new plugin, as
diff --git a/libgda-ui/gdaui-login.c b/libgda-ui/gdaui-login.c
index ea6b45a..32497b3 100644
--- a/libgda-ui/gdaui-login.c
+++ b/libgda-ui/gdaui-login.c
@@ -486,12 +486,12 @@ cnc_params_editor_changed_cb (GdauiProviderSpecEditor *editor, GdauiLogin *login
}
/**
- * gdaui_login_new
+ * gdaui_login_new:
* @dsn: a data source name, or %NULL
*
* Creates a new login widget which enables the user to specify connection parameters.
*
- * Returns: a new widget
+ * Returns: (transfer full): a new widget
*
* Since: 4.2
*/
@@ -506,7 +506,7 @@ gdaui_login_new (const gchar *dsn)
/**
- * gdaui_login_set_mode
+ * gdaui_login_set_mode:
* @login: a #GdauiLogin object
* @mode: a flag
*
@@ -559,14 +559,14 @@ gdaui_login_set_mode (GdauiLogin *login, GdauiLoginMode mode)
}
/**
- * gdaui_login_get_connection_information
+ * gdaui_login_get_connection_information:
* @login: a #GdauiLogin object
*
* Get the information specified in @login as a pointer to a (read-only) #GdaDsnInfo.
* If the connection is not specified by a DSN, then the 'name' attribute of the returned
* #GdaDsnInfo will be %NULL, and otherwise it will contain the name of the selected DSN.
*
- * Retuns: a pointer to a (read-only) #GdaDsnInfo.
+ * Retuns: (transfer none): a pointer to a (read-only) #GdaDsnInfo.
*
* Since: 4.2
*/
@@ -608,7 +608,7 @@ gdaui_login_get_connection_information (GdauiLogin *login)
}
/**
- * gdaui_login_set_dsn
+ * gdaui_login_set_dsn:
* @login: a #GdauiLogin object
* @dsn: a data source name, or %NULL
*
@@ -634,7 +634,7 @@ gdaui_login_set_dsn (GdauiLogin *login, const gchar *dsn)
}
/**
- * gdaui_login_set_connection_information
+ * gdaui_login_set_connection_information:
* @login: a #GdauiLogin object
* @cinfo: a pointer to a structure representing the information to display.
*
diff --git a/libgda-ui/gdaui-provider-selector.c b/libgda-ui/gdaui-provider-selector.c
index c6cd94b..3c89541 100644
--- a/libgda-ui/gdaui-provider-selector.c
+++ b/libgda-ui/gdaui-provider-selector.c
@@ -1,5 +1,5 @@
/* GNOME DB library
- * Copyright (C) 1999 - 2009 The GNOME Foundation.
+ * Copyright (C) 1999 - 2010 The GNOME Foundation.
*
* AUTHORS:
* Rodrigo Moya <rodrigo gnome-db org>
@@ -122,11 +122,11 @@ gdaui_provider_selector_get_type (void)
}
/**
- * gdaui_provider_selector_new
+ * gdaui_provider_selector_new:
*
* Create a new #GdauiProviderSelector widget.
*
- * Returns: the newly created widget.
+ * Returns: (transfer full): the newly created widget.
*/
GtkWidget *
gdaui_provider_selector_new (void)
@@ -138,12 +138,12 @@ gdaui_provider_selector_new (void)
}
/**
- * gdaui_provider_selector_get_provider
+ * gdaui_provider_selector_get_provider:
* @selector: a #GdauiProviderSelector widget
*
* Get the selected provider.
*
- * Returns: the selected provider, or %NULL if no provider is selected
+ * Returns: (transfer none): the selected provider, or %NULL if no provider is selected
*
* Since: 4.2
*/
@@ -165,13 +165,13 @@ gdaui_provider_selector_get_provider (GdauiProviderSelector *selector)
}
/**
- * gdaui_provider_selector_set_provider
+ * gdaui_provider_selector_set_provider:
* @selector: a #GdauiProviderSelector widget
- * @provider: the provider to be selected, or %NULL for the default (SQLite)
+ * @provider: (allow-none): the provider to be selected, or %NULL for the default (SQLite)
*
* Forces @selector to be set on @provider
*
- * Returns: TRUE if @provider has been selected
+ * Returns: %TRUE if @provider has been selected
*
* Since: 4.2
*/
@@ -198,12 +198,12 @@ gdaui_provider_selector_set_provider (GdauiProviderSelector *selector, const gch
}
/**
- * gdaui_provider_selector_get_provider_obj
+ * gdaui_provider_selector_get_provider_obj:
* @selector: a #GdauiProviderSelector widget
*
* Get the selected provider as a #GdaServerProvider object
*
- * Returns: a new #GdaServerProvider or %NULL if an error occurred
+ * Returns: (transfer none): a #GdaServerProvider or %NULL if an error occurred
*
* Since: 4.2
*/
diff --git a/libgda-ui/gdaui-raw-form.c b/libgda-ui/gdaui-raw-form.c
index b8f70b0..97feb0e 100644
--- a/libgda-ui/gdaui-raw-form.c
+++ b/libgda-ui/gdaui-raw-form.c
@@ -1,6 +1,6 @@
/* gdaui-raw-form.c
*
- * Copyright (C) 2002 - 2009 Vivien Malerba <malerba gnome-db org>
+ * Copyright (C) 2002 - 2010 Vivien Malerba <malerba gnome-db org>
*
* This Library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public License as
@@ -294,12 +294,12 @@ gdaui_raw_form_init (GdauiRawForm *wid)
}
/**
- * gdaui_raw_form_new
+ * gdaui_raw_form_new:
* @model: a #GdaDataModel, or %NULL
*
* Creates a new #GdauiRawForm widget to display data in @model
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*
* Since: 4.2
*/
diff --git a/libgda-ui/gdaui-raw-grid.c b/libgda-ui/gdaui-raw-grid.c
index 7f2688f..c59e0a7 100644
--- a/libgda-ui/gdaui-raw-grid.c
+++ b/libgda-ui/gdaui-raw-grid.c
@@ -389,12 +389,12 @@ gdaui_raw_grid_init (GdauiRawGrid *grid)
}
/**
- * gdaui_raw_grid_new
+ * gdaui_raw_grid_new:
* @model: a #GdaDataModel
*
* Creates a new #GdauiRawGrid widget suitable to display the data in @model
*
- * Returns: the new widget
+ * Returns: (transfer full): the new widget
*
* Since: 4.2
*/
@@ -2382,9 +2382,12 @@ get_column_data_for_id (GdauiRawGrid *grid, const gchar *id)
}
/**
- * gdaui_raw_grid_set_sample_size
+ * gdaui_raw_grid_set_sample_size:
* @grid: a #GdauiRawGrid
- * @sample_size:
+ * @sample_size: the size of the sample displayed in @grid
+ *
+ * Sets the size of each chunk of data to display: the maximum number of rows which
+ * can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_set_sample_size()
*
* Since: 4.2
*/
@@ -2398,7 +2401,7 @@ gdaui_raw_grid_set_sample_size (GdauiRawGrid *grid, gint sample_size)
}
/**
- * gdaui_raw_grid_set_sample_start
+ * gdaui_raw_grid_set_sample_start:
* @grid: a #GdauiRawGrid
* @sample_start:
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
