[grilo] core: Fix introspection annotations
- From: Juan A. Suarez Romero <jasuarez src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [grilo] core: Fix introspection annotations
- Date: Mon, 6 Aug 2012 16:50:52 +0000 (UTC)
commit 8d162930251d03e0be8e1992fc086ff5a310ad0d
Author: Juan A. Suarez Romero <jasuarez igalia com>
Date: Sat Jul 14 11:48:54 2012 +0000
core: Fix introspection annotations
libs/net/grl-net-wc.c | 10 +++++-----
src/data/grl-related-keys.c | 1 -
src/grl-caps.c | 2 +-
src/grl-error.h | 7 -------
src/grl-operation.c | 4 ++++
src/grl-plugin.c | 4 ++--
src/grl-range-value.c | 5 +++++
src/grl-source.c | 22 +++++++++++-----------
src/grl-value-helper.c | 12 ++++++++----
9 files changed, 36 insertions(+), 31 deletions(-)
---
diff --git a/libs/net/grl-net-wc.c b/libs/net/grl-net-wc.c
index ebb15cf..6d1fb32 100644
--- a/libs/net/grl-net-wc.c
+++ b/libs/net/grl-net-wc.c
@@ -91,7 +91,7 @@ grl_net_wc_class_init (GrlNetWcClass *klass)
g_type_class_add_private (klass, sizeof (GrlNetWcPrivate));
/**
- * GrlNetWc::loglevel
+ * GrlNetWc::loglevel:
*
* The log level for HTTP connections. This value is used by libsoup.
*/
@@ -105,7 +105,7 @@ grl_net_wc_class_init (GrlNetWcClass *klass)
G_PARAM_STATIC_STRINGS));
/**
- * GrlNetWc::throttling
+ * GrlNetWc::throttling:
*
* The timeout in seconds between connections. All the connections will be
* queued and each one will be dispatched after waiting this value.
@@ -119,7 +119,7 @@ grl_net_wc_class_init (GrlNetWcClass *klass)
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
/**
- * GrlNetWc::cache
+ * GrlNetWc::cache:
*
* %TRUE if cache must be used. %FALSE otherwise.
*/
@@ -133,7 +133,7 @@ grl_net_wc_class_init (GrlNetWcClass *klass)
G_PARAM_CONSTRUCT |
G_PARAM_STATIC_STRINGS));
/**
- * GrlNetWc::cache-size
+ * GrlNetWc::cache-size:
*
* Maximum size of cache, in Mb. Default value is 10Mb.
*/
@@ -147,7 +147,7 @@ grl_net_wc_class_init (GrlNetWcClass *klass)
G_PARAM_CONSTRUCT |
G_PARAM_STATIC_STRINGS));
/**
- * GrlNetWc::user-agent
+ * GrlNetWc::user-agent:
*
* User agent identifier.
*/
diff --git a/src/data/grl-related-keys.c b/src/data/grl-related-keys.c
index 960be80..65ab710 100644
--- a/src/data/grl-related-keys.c
+++ b/src/data/grl-related-keys.c
@@ -484,7 +484,6 @@ grl_related_keys_get_binary (GrlRelatedKeys *relkeys,
/**
* grl_related_keys_set_boxed:
- *
* @relkeys: set of related keys to modify
* @key: key to change or add
* @boxed: the new value
diff --git a/src/grl-caps.c b/src/grl-caps.c
index 0654240..2a9d6cb 100644
--- a/src/grl-caps.c
+++ b/src/grl-caps.c
@@ -24,6 +24,7 @@
* SECTION:grl-caps
* @short_description: Describes the capabilities of a source for a given
* operation.
+ * @see_also: #GrlOperationOptions, grl_metadata_source_get_caps()
*
* A #GrlCaps instance is here to help you know if a given set of operation
* options is supported for a given operation.
@@ -42,7 +43,6 @@
* A #GrlCaps can also be passed to grl_operation_options_new(). The created
* #GrlOperationOptions instance would then check any change against its caps.
*
- * @see_also: #GrlOperationOptions, grl_metadata_source_get_caps()
*/
#include <grl-caps.h>
#include <grl-value-helper.h>
diff --git a/src/grl-error.h b/src/grl-error.h
index cddf0af..8c48625 100644
--- a/src/grl-error.h
+++ b/src/grl-error.h
@@ -20,13 +20,6 @@
*
*/
-/**
- * SECTION:grl-error
- * @short_description: Error system
- *
- * This class stores information related to the error system
- */
-
#if !defined (_GRILO_H_INSIDE_) && !defined (GRILO_COMPILATION)
#error "Only <grilo.h> can be included directly."
#endif
diff --git a/src/grl-operation.c b/src/grl-operation.c
index af77f1c..a0baa36 100644
--- a/src/grl-operation.c
+++ b/src/grl-operation.c
@@ -86,6 +86,10 @@ grl_operation_set_private_data (guint operation_id,
data->private_data = private_data;
}
+/**
+ * grl_operation_get_private_data: (skip)
+ * @operation_id: operation identifier
+ **/
gpointer
grl_operation_get_private_data (guint operation_id)
{
diff --git a/src/grl-plugin.c b/src/grl-plugin.c
index aa8e7b8..ff08189 100644
--- a/src/grl-plugin.c
+++ b/src/grl-plugin.c
@@ -95,7 +95,7 @@ grl_plugin_class_init (GrlPluginClass *plugin_class)
G_PARAM_STATIC_STRINGS);
/**
- * GrlPlugin:loaded
+ * GrlPlugin:loaded:
*
* @TRUE if plugin is loaded.
*/
@@ -201,7 +201,7 @@ grl_plugin_set_unload_func (GrlPlugin *plugin,
/**
* grl_plugin_load:
* @plugin: a plugin
- * @configurations: a list of configurations
+ * @configurations: (element-type Grl.Config): a list of configurations
*
* Load the plugin
*
diff --git a/src/grl-range-value.c b/src/grl-range-value.c
index 6dfb4ab..fcb6c9d 100644
--- a/src/grl-range-value.c
+++ b/src/grl-range-value.c
@@ -69,6 +69,11 @@ grl_range_value_free (GrlRangeValue *range)
g_slice_free (GrlRangeValue, range);
}
+/**
+ * grl_range_value_hashtable_new: (skip)
+ *
+ * Returns: a #GHashTable
+ **/
GHashTable *
grl_range_value_hashtable_new (void)
{
diff --git a/src/grl-source.c b/src/grl-source.c
index 71046dc..2f2cca0 100644
--- a/src/grl-source.c
+++ b/src/grl-source.c
@@ -265,7 +265,7 @@ grl_source_class_init (GrlSourceClass *source_class)
gobject_class->get_property = grl_source_get_property;
/**
- * GrlSource:source-id
+ * GrlSource:source-id:
*
* The identifier of the source.
*/
@@ -279,7 +279,7 @@ grl_source_class_init (GrlSourceClass *source_class)
G_PARAM_CONSTRUCT |
G_PARAM_STATIC_STRINGS));
/**
- * GrlSource:source-name
+ * GrlSource:source-name:
*
* The name of the source.
*/
@@ -293,7 +293,7 @@ grl_source_class_init (GrlSourceClass *source_class)
G_PARAM_CONSTRUCT |
G_PARAM_STATIC_STRINGS));
/**
- * GrlSource:source-desc
+ * GrlSource:source-desc:
*
* A description of the source
*/
@@ -307,7 +307,7 @@ grl_source_class_init (GrlSourceClass *source_class)
G_PARAM_CONSTRUCT |
G_PARAM_STATIC_STRINGS));
/**
- * GrlSource:plugin
+ * GrlSource:plugin:
*
* Plugin the source belongs to
*/
@@ -321,7 +321,7 @@ grl_source_class_init (GrlSourceClass *source_class)
G_PARAM_CONSTRUCT |
G_PARAM_STATIC_STRINGS));
/**
- * GrlSource:rank
+ * GrlSource:rank:
*
* Source rank
*/
@@ -337,7 +337,7 @@ grl_source_class_init (GrlSourceClass *source_class)
G_PARAM_CONSTRUCT |
G_PARAM_STATIC_STRINGS));
/**
- * GrlSource:auto-split-threshold
+ * GrlSource:auto-split-threshold:
*
* Transparently split queries with count requests
* bigger than a certain threshold into smaller queries.
@@ -1269,7 +1269,7 @@ get_additional_sources (GrlSource *source,
return list_union (NULL, result, NULL);
}
-/**
+/*
* Will add to @keys the keys that should be asked to @source when doing an
* operation with GRL_RESOLVE_FULL.
* The added keys are the keys that will be needed by other sources to obtain
@@ -3167,7 +3167,7 @@ grl_source_resolve_sync (GrlSource *source,
* @source: a source
* @media: a media on which we want more metadata
* @key_id: the key corresponding to a metadata we might want
- * @missing_keys: an optional originally empty list
+ * @missing_keys: (element-type GrlKeyID): an optional originally empty list
*
* Checks whether @key_id may be resolved with @source for @media, so that the
* caller can avoid calling grl_source_resolve() if it can be known in
@@ -3265,8 +3265,8 @@ grl_source_test_media_from_uri (GrlSource *source,
* grl_source_get_media_from_uri:
* @source: a source
* @uri: A URI that can be used to identify a media resource
- * @keys: A list of keys to resolve
- * @flags: the resolution mode
+ * @keys: (element-type GrlKeyID): A list of keys to resolve
+ * @options: options wanted for that operation
* @callback: (scope notified): the user defined callback
* @user_data: the user data to pass in the callback
*
@@ -3362,7 +3362,7 @@ grl_source_get_media_from_uri (GrlSource *source,
* grl_source_get_media_from_uri_sync:
* @source: a source
* @uri: A URI that can be used to identify a media resource
- * @keys: A list of keys to resolve
+ * @keys: (element-type GrlKeyID): a list of keys to resolve
* @options: options wanted for that operation
* @error: a #GError, or @NULL
*
diff --git a/src/grl-value-helper.c b/src/grl-value-helper.c
index 74fe7cb..5507ec5 100644
--- a/src/grl-value-helper.c
+++ b/src/grl-value-helper.c
@@ -34,7 +34,7 @@
/**
- * grl_g_value_new: (skip):
+ * grl_g_value_new: (skip)
*/
GValue *
grl_g_value_new (GType g_type)
@@ -48,7 +48,7 @@ grl_g_value_new (GType g_type)
}
/**
- * grl_g_value_free: (skip):
+ * grl_g_value_free: (skip)
*/
void
grl_g_value_free (GValue *value)
@@ -58,7 +58,8 @@ grl_g_value_free (GValue *value)
}
/**
- * grl_g_value_hashtable_new: (skip):
+ * grl_g_value_hashtable_new: (skip)
+ *
* Returns: a new hash table made to contain GValues.
*/
GHashTable *
@@ -67,6 +68,9 @@ grl_g_value_hashtable_new (void)
return g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify)grl_g_value_free);
}
+/**
+ * grl_g_value_hashtable_new_direct: (skip)
+ */
GHashTable *
grl_g_value_hashtable_new_direct (void)
{
@@ -74,7 +78,7 @@ grl_g_value_hashtable_new_direct (void)
}
/**
- * grl_g_value_dup: (skip):
+ * grl_g_value_dup: (skip)
*/
GValue *
grl_g_value_dup (const GValue *value)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]