GNOME.org
 

[libgda/gtk3] Doc. corrections

commit d397f0ec21738377ba26a0820930e5d974389857
Author: Vivien Malerba <malerba gnome-db org>
Date:   Mon Feb 28 18:17:07 2011 +0100

    Doc. corrections

 doc/C/Makefile.am                               |    2 +-
 doc/C/libgda-sections.txt                       |    2 +-
 libgda-report/engine/rt-parser.c                |    5 ++---
 libgda-ui/data-entries/gdaui-entry.h            |    4 ++--
 libgda-ui/internal/gdaui-provider-auth-editor.c |   16 ++++++++--------
 libgda-ui/internal/gdaui-provider-spec-editor.c |   12 ++++++------
 libgda-ui/internal/utility.c                    |   22 +++++++++++-----------
 libgda/gda-attributes-manager.c                 |    5 ++---
 libgda/gda-config.h                             |    1 +
 libgda/gda-connection.h                         |    1 +
 libgda/gda-meta-struct.c                        |    2 +-
 libgda/gda-meta-struct.h                        |    2 +-
 libgda/gda-mutex.c                              |    2 +-
 libgda/gda-server-operation.c                   |    4 ++--
 libgda/gda-server-provider-extra.c              |    2 +-
 libgda/gda-transaction-status.c                 |    4 ++--
 libgda/gda-tree-manager.c                       |    2 +-
 libgda/gda-tree.c                               |    1 +
 libgda/gda-value.c                              |    4 ++--
 libgda/gda-xa-transaction.c                     |    2 +-
 libgda/handlers/gda-handler-time.c              |    8 ++++----
 21 files changed, 52 insertions(+), 51 deletions(-)
---
diff --git a/doc/C/Makefile.am b/doc/C/Makefile.am
index b560eef..2011500 100644
--- a/doc/C/Makefile.am
+++ b/doc/C/Makefile.am
@@ -51,7 +51,7 @@ GTKDOC_LIBS += $(GTK_LIBS) \
 endif
 
 # Extra options to supply to gtkdoc-mkdb
-MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=gda --ignore-files="parser.c delimiter.c binreloc.c libcsv.c md5c.c providers tools control-center tests samples plugins"
+MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=gda --ignore-files="parser.c delimiter.c binreloc.c libcsv.c md5c.c providers tools control-center tests tmp samples plugins"
 
 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
 content_files = fdl-appendix.sgml version.xml builddate.xml
diff --git a/doc/C/libgda-sections.txt b/doc/C/libgda-sections.txt
index e676bd6..3320582 100644
--- a/doc/C/libgda-sections.txt
+++ b/doc/C/libgda-sections.txt
@@ -829,7 +829,7 @@ gda_data_handler_get_value_from_str
 gda_data_handler_get_sane_init_value
 gda_data_handler_accepts_g_type
 gda_data_handler_get_descr
-<SUBECTION>
+<SUBSECTION>
 gda_data_handler_get_default
 <SUBSECTION Standard>
 GDA_DATA_HANDLER
diff --git a/libgda-report/engine/rt-parser.c b/libgda-report/engine/rt-parser.c
index 0553124..d4a4c69 100644
--- a/libgda-report/engine/rt-parser.c
+++ b/libgda-report/engine/rt-parser.c
@@ -1,5 +1,4 @@
-/* rt-parser.c
- *
+/*
  * Copyright (C) 2010 - 2011 Vivien Malerba <malerba gnome-db org>
  *
  * This Library is free software; you can redistribute it and/or
@@ -125,7 +124,7 @@ get_token (const gchar *alltext, const gchar *start, gint *out_nb_spaces_before,
 	return MARKUP_NONE;
 }
 
-/**
+/*
  * get_markup_token
  * @alltext: the complete text
  * @start: starting point
diff --git a/libgda-ui/data-entries/gdaui-entry.h b/libgda-ui/data-entries/gdaui-entry.h
index c7216a5..dd5214b 100644
--- a/libgda-ui/data-entries/gdaui-entry.h
+++ b/libgda-ui/data-entries/gdaui-entry.h
@@ -59,7 +59,7 @@ struct _GdauiEntryClass
 
 	/**
 	 * GdauiEntryClass::assume_insert
-	 * @entry:
+	 * @entry: a #GdauiEntry
 	 * @text: the text to be inserted
 	 * @text_length: @text's length in bytes (not characters)
 	 * @virt_pos: the position where @text is to be inserted
@@ -71,7 +71,7 @@ struct _GdauiEntryClass
 						  gint *virt_pos, gint offset);
 	/**
 	 * GdauiEntryClass::assume_delete
-	 * @entry:
+	 * @entry: a #GdauiEntry
 	 * @virt_start_pos: the starting position.
 	 * @virt_end_pos: the end position (not included in deletion), always > @start_pos
 	 * @offset: an offset to add to positions using @virt_start_pos or @virt_end_pos as reference
diff --git a/libgda-ui/internal/gdaui-provider-auth-editor.c b/libgda-ui/internal/gdaui-provider-auth-editor.c
index d50c54f..1aa87e5 100644
--- a/libgda-ui/internal/gdaui-provider-auth-editor.c
+++ b/libgda-ui/internal/gdaui-provider-auth-editor.c
@@ -1,5 +1,5 @@
-/* GNOME DB library
- * Copyright (C) 2008 The GNOME Foundation
+/*
+ * Copyright (C) 2008 - 2011 The GNOME Foundation
  *
  * AUTHORS:
  *      Vivien Malerba <malerba gnome-db org>
@@ -208,7 +208,7 @@ _gdaui_provider_auth_editor_get_type (void)
 	return type;
 }
 
-/**
+/*
  * _gdaui_provider_auth_editor_new
  * @provider: the provider to be used 
  *
@@ -227,7 +227,7 @@ _gdaui_provider_auth_editor_new (const gchar *provider)
 	return GTK_WIDGET (auth);
 }
 
-/**
+/*
  * _gdaui_provider_auth_editor_set_provider
  * @auth: a #GdauiProviderAuthEditor widget
  * @provider: the provider to be used 
@@ -290,7 +290,7 @@ _gdaui_provider_auth_editor_set_provider (GdauiProviderAuthEditor *auth, const g
 	g_signal_emit_by_name (auth, "changed");
 }
 
-/**
+/*
  * _gdaui_provider_auth_editor_is_valid
  * @auth: a #GdauiProviderAuthEditor widget
  * 
@@ -367,7 +367,7 @@ params_to_string (GdauiProviderAuthEditor *auth)
 	return str;
 }
 
-/**
+/*
  * _gdaui_provider_auth_editor_get_auths
  * @auth: a #GdauiProviderAuthEditor widget
  *
@@ -393,7 +393,7 @@ _gdaui_provider_auth_editor_get_auth (GdauiProviderAuthEditor *auth)
 		return NULL;
 }
 
-/**
+/*
  * _gdaui_provider_auth_editor_set_auths
  * @auth: a #GdauiProviderAuthEditor widget
  * @auth_string: 
@@ -457,7 +457,7 @@ _gdaui_provider_auth_editor_set_auth (GdauiProviderAuthEditor *auth, const gchar
 	g_signal_emit_by_name (auth, "changed");
 }
 
-/**
+/*
  * _gdaui_provider_auth_editor_add_to_size_group
  * @auth: a #GdauiProviderAuthEditor widget
  */
diff --git a/libgda-ui/internal/gdaui-provider-spec-editor.c b/libgda-ui/internal/gdaui-provider-spec-editor.c
index 375c02d..8f507d0 100644
--- a/libgda-ui/internal/gdaui-provider-spec-editor.c
+++ b/libgda-ui/internal/gdaui-provider-spec-editor.c
@@ -1,4 +1,4 @@
-/* GNOME DB library
+/*
  * Copyright (C) 2005 - 2011 The GNOME Foundation
  *
  * AUTHORS:
@@ -416,7 +416,7 @@ params_to_string (GdauiProviderSpecEditor *spec)
 	return str;
 }
 
-/**
+/*
  * _gdaui_provider_spec_editor_set_provider
  * @spec: a #GdauiProviderSpecEditor widget
  * @provider: the provider to be used 
@@ -440,7 +440,7 @@ _gdaui_provider_spec_editor_set_provider (GdauiProviderSpecEditor *spec, const g
 	adapt_form_widget (spec);
 }
 
-/**
+/*
  * _gdaui_provider_spec_editor_is_valid
  * @spec: a #GdauiProviderSpecEditor widget
  * 
@@ -464,7 +464,7 @@ _gdaui_provider_spec_editor_is_valid (GdauiProviderSpecEditor *spec)
 	}
 }
 
-/**
+/*
  * _gdaui_provider_spec_editor_get_specs
  * @spec: a #GdauiProviderSpecEditor widget
  *
@@ -487,7 +487,7 @@ _gdaui_provider_spec_editor_get_specs (GdauiProviderSpecEditor *spec)
 	}
 }
 
-/**
+/*
  * _gdaui_provider_spec_editor_set_specs
  * @spec: a #GdauiProviderSpecEditor widget
  * @specs_string: the connection string
@@ -511,7 +511,7 @@ _gdaui_provider_spec_editor_set_specs (GdauiProviderSpecEditor *spec, const gcha
 	update_form_contents (spec);
 }
 
-/**
+/*
  * _gdaui_provider_spec_editor_add_to_size_group
  * @spec: a #GdauiProviderSpecEditor widget
  */
diff --git a/libgda-ui/internal/utility.c b/libgda-ui/internal/utility.c
index e5face5..72ca15e 100644
--- a/libgda-ui/internal/utility.c
+++ b/libgda-ui/internal/utility.c
@@ -1,5 +1,4 @@
-/* utility.c
- *
+/*
  * Copyright (C) 2003 - 2011 Vivien Malerba <malerba gnome-db org>
  *
  * This library is free software; you can redistribute it and/or
@@ -119,7 +118,7 @@ _gdaui_utility_entry_build_actions_menu (GObject *obj_data, guint attrs, GCallba
 }
 
 
-/**
+/*
  * _gdaui_utility_entry_build_info_colors_array
  * 
  * Creates an array of colors for the different states of an entry:
@@ -132,7 +131,8 @@ _gdaui_utility_entry_build_actions_menu (GObject *obj_data, guint attrs, GCallba
  *
  * Returns: a new array of 6 colors
  */
-GdkColor **_gdaui_utility_entry_build_info_colors_array ()
+GdkColor **
+_gdaui_utility_entry_build_info_colors_array (void)
 {
 	GdkColor **colors;
 	GdkColor *color;
@@ -171,7 +171,7 @@ GdkColor **_gdaui_utility_entry_build_info_colors_array ()
 	return colors;
 }
 
-/**
+/*
  * _gdaui_utility_markup_title
  */
 gchar *
@@ -183,7 +183,7 @@ _gdaui_utility_markup_title (const gchar *title, gboolean optional)
 		return g_strdup_printf ("%s:", title);
 }
 
-/**
+/*
  * _gdaui_utility_proxy_compute_attributes_for_group
  *
  * Computes an attributes from the individual attributes of the values stored in @store and
@@ -230,7 +230,7 @@ _gdaui_utility_proxy_compute_attributes_for_group (GdauiSetGroup *group, GdauiDa
         return attributes;
 }
 
-/**
+/*
  * _gdaui_utility_proxy_compute_values_for_group:
  *
  * Computes a list of values containing the individual values stored in @store and
@@ -426,7 +426,7 @@ create_data_error_dialog (GdauiDataProxy *form, gboolean with_question, gboolean
 	return dlg;
 }
 
-/**
+/*
  * _gdaui_utility_display_error_with_keep_or_discard_choice
  * @form: a #GdauiDataProxy
  * @filled_error: a #GError containing the error to display
@@ -455,7 +455,7 @@ _gdaui_utility_display_error_with_keep_or_discard_choice (GdauiDataProxy *form,
 	return (res == GTK_RESPONSE_REJECT) ? TRUE : FALSE;
 }
 
-/**
+/*
  * _gdaui_utility_display_error
  * @form: a #GdauiDataProxy
  * @filled_error: a #GError containing the error to display
@@ -478,8 +478,8 @@ _gdaui_utility_display_error (GdauiDataProxy *form, gboolean can_discard, GError
 
 }
 
-/**
- * gnome_db_show_error
+/*
+ * _gdaui_utility_show_error
  * @format:
  * @...:
  *
diff --git a/libgda/gda-attributes-manager.c b/libgda/gda-attributes-manager.c
index 2e59734..8124814 100644
--- a/libgda/gda-attributes-manager.c
+++ b/libgda/gda-attributes-manager.c
@@ -1,6 +1,5 @@
 /* 
- * GDA common library
- * Copyright (C) 2008 - 2010 The GNOME Foundation.
+ * Copyright (C) 2008 - 2011 The GNOME Foundation.
  *
  * AUTHORS:
  *      Vivien Malerba <malerba gnome-db org>
@@ -91,7 +90,7 @@ objattrs_unref (ObjAttrs *attrs)
 }
 
 /**
- * gda_attributes_manager_new: (skip):
+ * gda_attributes_manager_new: (skip)
  * @for_objects: set to TRUE if attributes will be set on objects.
  * @signal_func: a function to be called whenever an attribute changes on an object (if @for_objects is TRUE), or %NULL
  * @signal_data: user data passed as last argument of @signal_func when it is called
diff --git a/libgda/gda-config.h b/libgda/gda-config.h
index 00a9eb8..cf5e86d 100644
--- a/libgda/gda-config.h
+++ b/libgda/gda-config.h
@@ -80,6 +80,7 @@ struct _GdaDsnInfo {
  * GdaProviderInfo:
  * @id: the unique identifier of the database provider
  * @location: the complete path to the shared library implementing the database provider
+ * @description: provider's description
  * @dsn_params: a #GdaSet containing all the parameters which can/must be specified when opening a connection or defining a named data source (DSN)
  * @auth_params: a #GdaSet containing all the authentication parameters
  *
diff --git a/libgda/gda-connection.h b/libgda/gda-connection.h
index d7ffacb..9a4b75e 100644
--- a/libgda/gda-connection.h
+++ b/libgda/gda-connection.h
@@ -171,6 +171,7 @@ typedef enum {
  * @GDA_CONNECTION_FEATURE_VIEWS: test for views support
  * @GDA_CONNECTION_FEATURE_XA_TRANSACTIONS: test for distributed transactions support
  * @GDA_CONNECTION_FEATURE_MULTI_THREADING: test for native multi-threading support
+ * @GDA_CONNECTION_FEATURE_LAST: not used
  *
  * Used in gda_connection_supports_feature() and gda_server_provider_supports_feature() to test if a connection
  * or a database provider supports some specific feature.
diff --git a/libgda/gda-meta-struct.c b/libgda/gda-meta-struct.c
index ea26aae..cccd3cc 100644
--- a/libgda/gda-meta-struct.c
+++ b/libgda/gda-meta-struct.c
@@ -1889,7 +1889,7 @@ gda_meta_struct_get_db_object (GdaMetaStruct *mstruct, const GValue *catalog, co
 }
 
 /**
- * gda_meta_struct_get_table_column: (skip):
+ * gda_meta_struct_get_table_column: (skip)
  * @mstruct: a #GdaMetaStruct object
  * @table: the #GdaMetaTable structure to find the column for
  * @col_name: the name of the column to find (as a G_TYPE_STRING GValue)
diff --git a/libgda/gda-meta-struct.h b/libgda/gda-meta-struct.h
index ae4843c..e82af8c 100644
--- a/libgda/gda-meta-struct.h
+++ b/libgda/gda-meta-struct.h
@@ -162,7 +162,7 @@ typedef struct {
  * GdaMetaDbObject:
  * @extra: union for the actual object's contents, to be able to cast it using GDA_META_TABLE(), GDA_META_VIEW()
  * @obj_type: the type of object (table, view)
- * @outdated:
+ * @outdated: set to %TRUE if the information in this #GdaMetaDbObject may be outdated because the #GdaMetaStore has been updated
  * @obj_catalog: the catalog the object is in
  * @obj_schema: the schema the object is in
  * @obj_name: the object's name
diff --git a/libgda/gda-mutex.c b/libgda/gda-mutex.c
index 1cedac1..7e322fd 100644
--- a/libgda/gda-mutex.c
+++ b/libgda/gda-mutex.c
@@ -187,7 +187,7 @@ gda_mutex_usage_unlocked (GdaMutex *mutex)
 #endif
 
 /**
- * gda_mutex_new: (skip):
+ * gda_mutex_new: (skip)
  *
  * Creates a new #GdaMutex.
  *
diff --git a/libgda/gda-server-operation.c b/libgda/gda-server-operation.c
index 0e46025..c690fcb 100644
--- a/libgda/gda-server-operation.c
+++ b/libgda/gda-server-operation.c
@@ -1071,7 +1071,7 @@ gda_server_operation_new (GdaServerOperationType op_type, const gchar *xml_file)
 }
 
 /**
- * gda_server_operation_get_node_info: (skip):
+ * gda_server_operation_get_node_info: (skip)
  * @op: a #GdaServerOperation object
  * @path_format: a complete path to a node (starting with "/") as a format string, similar to g_strdup_printf()'s argument
  * @...: the arguments to insert into the format string
@@ -1312,7 +1312,7 @@ gda_server_operation_string_to_op_type (const gchar *str)
 static gboolean node_save (GdaServerOperation *op, Node *opnode, xmlNodePtr parent);
 
 /**
- * gda_server_operation_save_data_to_xml: (skip):
+ * gda_server_operation_save_data_to_xml: (skip)
  * @op: a #GdaServerOperation object
  * @error: (allow-none): a place to store errors or %NULL
  * 
diff --git a/libgda/gda-server-provider-extra.c b/libgda/gda-server-provider-extra.c
index 6e958e5..86d699d 100644
--- a/libgda/gda-server-provider-extra.c
+++ b/libgda/gda-server-provider-extra.c
@@ -1,4 +1,4 @@
-/* GDA common library
+/*
  * Copyright (C) 2005 - 2010 The GNOME Foundation.
  *
  * AUTHORS:
diff --git a/libgda/gda-transaction-status.c b/libgda/gda-transaction-status.c
index 4aad698..5a67698 100644
--- a/libgda/gda-transaction-status.c
+++ b/libgda/gda-transaction-status.c
@@ -152,7 +152,7 @@ gda_transaction_status_new (const gchar *name)
 }
 
 /**
- * gda_transaction_status_add_event_svp: (skip):
+ * gda_transaction_status_add_event_svp: (skip)
  *
  */
 GdaTransactionStatusEvent *
@@ -173,7 +173,7 @@ gda_transaction_status_add_event_svp (GdaTransactionStatus *tstatus, const gchar
 }
 
 /**
- * gda_transaction_status_add_event_sql: (skip):
+ * gda_transaction_status_add_event_sql: (skip)
  *
  */
 GdaTransactionStatusEvent *
diff --git a/libgda/gda-tree-manager.c b/libgda/gda-tree-manager.c
index 8024b7b..99571da 100644
--- a/libgda/gda-tree-manager.c
+++ b/libgda/gda-tree-manager.c
@@ -465,7 +465,7 @@ gda_tree_manager_set_node_create_func (GdaTreeManager *manager, GdaTreeManagerNo
 }
 
 /**
- * gda_tree_manager_get_node_create_func: (skip):
+ * gda_tree_manager_get_node_create_func: (skip)
  * @manager: a #GdaTreeManager tree manager object
  *
  * Get the function used by @manager when creating new #GdaTreeNode nodes
diff --git a/libgda/gda-tree.c b/libgda/gda-tree.c
index 7f957c5..31c33ee 100644
--- a/libgda/gda-tree.c
+++ b/libgda/gda-tree.c
@@ -172,6 +172,7 @@ gda_tree_class_init (GdaTreeClass *klass)
 
 	/**
 	 * GdaTree:is-list:
+	 *
 	 * Tells if the GdaTree is a list or a tree.
 	 */
 	g_object_class_install_property (object_class, PROP_IS_LIST,
diff --git a/libgda/gda-value.c b/libgda/gda-value.c
index cf0e1b7..546831d 100644
--- a/libgda/gda-value.c
+++ b/libgda/gda-value.c
@@ -1,5 +1,5 @@
 /* GDA library
- * Copyright (C) 1998 - 2010 The GNOME Foundation.
+ * Copyright (C) 1998 - 2011 The GNOME Foundation.
  *
  * AUTHORS:
  *	Michael Lausch <michael lausch at>
@@ -2257,7 +2257,7 @@ to_string (const GValue *value)
 
 
 /**
- * gda_value_to_xml: (skip):
+ * gda_value_to_xml: (skip)
  * @value: a #GValue.
  *
  * Serializes the given #GValue to an XML node string.
diff --git a/libgda/gda-xa-transaction.c b/libgda/gda-xa-transaction.c
index c4134f7..15b852c 100644
--- a/libgda/gda-xa-transaction.c
+++ b/libgda/gda-xa-transaction.c
@@ -751,7 +751,7 @@ gda_xa_transaction_id_to_string (const GdaXaTransactionId *xid)
 }
 
 /**
- * gda_xa_transaction_string_to_id: (skip):
+ * gda_xa_transaction_string_to_id: (skip)
  * @str: a string representation of a #GdaXaTransactionId, in the "gtrid,bqual,formatID" format
  *
  * Creates a new #GdaXaTransactionId structure from its string representation, it's the opposite
diff --git a/libgda/handlers/gda-handler-time.c b/libgda/handlers/gda-handler-time.c
index 39e54af..5393f5e 100644
--- a/libgda/handlers/gda-handler-time.c
+++ b/libgda/handlers/gda-handler-time.c
@@ -232,7 +232,7 @@ gda_handler_time_new_no_locale (void)
 }
 
 /**
- * gda_handler_time_set_sql_spec
+ * gda_handler_time_set_sql_spec:
  * @dh: a #GdaHandlerTime object
  * @first: what comes first in the date representation
  * @sec: what comes second in the date representation
@@ -265,7 +265,7 @@ gda_handler_time_set_sql_spec  (GdaHandlerTime *dh, GDateDMY first, GDateDMY sec
 }
 
 /**
- * gda_handler_time_set_str_spec
+ * gda_handler_time_set_str_spec:
  * @dh: a #GdaHandlerTime object
  * @first: what comes first in the date representation
  * @sec: what comes second in the date representation
@@ -412,7 +412,7 @@ handler_compute_locale (GdaHandlerTime *hdl)
 }
 
 /**
- * gda_handler_time_get_no_locale_str_from_value
+ * gda_handler_time_get_no_locale_str_from_value:
  * @hdl: a #GdaHandlerTime object
  * @value: a GValue value
  *
@@ -485,7 +485,7 @@ gda_handler_time_get_no_locale_str_from_value (GdaHandlerTime *hdl, const GValue
 }
 
 /**
- * gda_handler_time_get_format
+ * gda_handler_time_get_format:
  * @dh: a #GdaHandlerTime object
  * @type: the type of data being handled
  *
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]