GNOME.org
 

[grilo] doc: Improve documentation

commit 38da1963a3c772b367c037bb449cde58b9b1efae
Author: Juan A. Suarez Romero <jasuarez igalia com>
Date:   Fri Aug 10 12:28:35 2012 +0200

    doc: Improve documentation

 doc/grilo/grilo-sections.txt |   36 ++++++++-
 src/data/grl-config.c        |  110 ++++++++++++++++++++++++++++
 src/grl-caps.c               |   31 ++++++++
 src/grl-log.c                |   20 +++++
 src/grl-operation-options.c  |   75 +++++++++++++++++++
 src/grl-operation.c          |    4 +-
 src/grl-plugin.c             |  165 ++++++++++++++++++++++--------------------
 src/grl-range-value.c        |   15 ++---
 src/grl-registry.c           |    4 +-
 src/grl-value-helper.c       |   21 +-----
 10 files changed, 367 insertions(+), 114 deletions(-)
---
diff --git a/doc/grilo/grilo-sections.txt b/doc/grilo/grilo-sections.txt
index 64d8230..a708b27 100644
--- a/doc/grilo/grilo-sections.txt
+++ b/doc/grilo/grilo-sections.txt
@@ -34,6 +34,7 @@ grl_plugin_get_author
 grl_plugin_get_site
 grl_plugin_get_id
 grl_plugin_get_filename
+grl_plugin_get_module
 grl_plugin_get_info_keys
 grl_plugin_get_info
 grl_plugin_get_sources
@@ -77,6 +78,8 @@ grl_source_writable_keys
 grl_source_get_id
 grl_source_get_name
 grl_source_get_description
+grl_source_get_plugin
+grl_source_get_rank
 grl_source_get_caps
 grl_source_may_resolve
 grl_source_resolve
@@ -120,7 +123,6 @@ GrlSourcePrivate
 GrlCaps
 grl_caps_get_key_filter
 grl_caps_get_key_range_filter
-grl_caps_get_type
 grl_caps_get_type_filter
 grl_caps_is_key_filter
 grl_caps_is_key_range_filter
@@ -129,6 +131,16 @@ grl_caps_set_key_filter
 grl_caps_set_key_range_filter
 grl_caps_set_type_filter
 grl_caps_test_option
+<SUBSECTION Standard>
+GRL_CAPS
+GRL_IS_CAPS
+GRL_TYPE_CAPS
+grl_caps_get_type
+GRL_CAPS_CLASS
+GRL_IS_CAPS_CLASS
+GRL_CAPS_GET_CLASS
+<SUBSECTION Private>
+GrlCapsPrivate
 </SECTION>
 
 <SECTION>
@@ -144,7 +156,6 @@ grl_operation_options_get_key_filter_list
 grl_operation_options_get_key_range_filter
 grl_operation_options_get_key_range_filter_list
 grl_operation_options_get_skip
-grl_operation_options_get_type
 grl_operation_options_get_type_filter
 grl_operation_options_key_is_set
 grl_operation_options_new
@@ -158,12 +169,23 @@ grl_operation_options_set_key_range_filter
 grl_operation_options_set_key_range_filter_value
 grl_operation_options_set_skip
 grl_operation_options_set_type_filter
+<SUBSECTION Standard>
+GRL_OPERATION_OPTIONS
+GRL_IS_OPERATION_OPTIONS
+GRL_TYPE_OPERATION_OPTIONS
+grl_operation_options_get_type
+GRL_OPERATION_OPTIONS_CLASS
+GRL_IS_OPERATION_OPTIONS_CLASS
+GRL_OPERATION_OPTIONS_GET_CLASS
+<SUBSECTION Private>
+GrlOperationOptionsPrivate
 </SECTION>
 
 <SECTION>
 <FILE>grl-registry</FILE>
 <TITLE>GrlRegistry</TITLE>
 GRL_PLUGIN_PATH_VAR
+GRL_PLUGIN_LIST_VAR
 GRL_PLUGIN_RANKS_VAR
 GRL_PLUGIN_REGISTER
 GrlPluginDescriptor
@@ -184,7 +206,6 @@ grl_registry_get_sources_by_operations
 grl_registry_lookup_plugin
 grl_registry_get_plugins
 grl_registry_register_metadata_key
-grl_registry_register_metadata_key_full
 grl_registry_register_metadata_key_relation
 grl_registry_lookup_metadata_key
 grl_registry_lookup_metadata_key_relation
@@ -220,11 +241,13 @@ grl_related_keys_set_string
 grl_related_keys_set_int
 grl_related_keys_set_float
 grl_related_keys_set_binary
+grl_related_keys_set_boxed
 grl_related_keys_get
 grl_related_keys_get_string
 grl_related_keys_get_int
 grl_related_keys_get_float
 grl_related_keys_get_binary
+grl_related_keys_get_boxed
 grl_related_keys_has_key
 grl_related_keys_get_keys
 grl_related_keys_dup
@@ -386,11 +409,13 @@ grl_data_set_string
 grl_data_set_int
 grl_data_set_float
 grl_data_set_binary
+grl_data_set_boxed
 grl_data_get
 grl_data_get_string
 grl_data_get_int
 grl_data_get_float
 grl_data_get_binary
+grl_data_get_boxed
 grl_data_remove
 grl_data_has_key
 grl_data_get_keys
@@ -399,6 +424,7 @@ grl_data_add_string
 grl_data_add_int
 grl_data_add_float
 grl_data_add_binary
+grl_data_add_boxed
 grl_data_length
 grl_data_get_related_keys
 grl_data_get_single_values_for_key
@@ -479,6 +505,7 @@ grl_media_audio_set_album
 grl_media_audio_set_genre
 grl_media_audio_set_lyrics
 grl_media_audio_set_bitrate
+grl_media_audio_set_track_number
 grl_media_audio_set_url_data
 grl_media_audio_add_artist
 grl_media_audio_add_genre
@@ -492,6 +519,7 @@ grl_media_audio_get_genre_nth
 grl_media_audio_get_lyrics
 grl_media_audio_get_lyrics_nth
 grl_media_audio_get_bitrate
+grl_media_audio_get_track_number
 grl_media_audio_get_url_data
 grl_media_audio_get_url_data_nth
 grl_media_audio_new
@@ -602,6 +630,7 @@ grl_metadata_key_list_new
 <FILE>grl-util</FILE>
 grl_paging_translate
 grl_list_from_va
+grl_date_time_from_iso8601
 </SECTION>
 
 <SECTION>
@@ -644,7 +673,6 @@ GRL_LOG_DOMAIN_STATIC
 GRL_LOG_DOMAIN_INIT
 GRL_LOG_DOMAIN_FREE
 GRL_LOG
-GRL_LOG_valist
 GRL_ERROR
 GRL_WARNING
 GRL_MESSAGE
diff --git a/src/data/grl-config.c b/src/data/grl-config.c
index 8cfcecb..0d68f01 100644
--- a/src/data/grl-config.c
+++ b/src/data/grl-config.c
@@ -123,6 +123,16 @@ grl_config_new (const gchar *plugin, const gchar *source)
   return config;
 }
 
+/**
+ * grl_config_set:
+ * @config: the config instance
+ * @param: a parameter
+ * @value: value
+ *
+ * Set @param @value.
+ *
+ * Since: 0.1.5
+ **/
 void
 grl_config_set (GrlConfig *config, const gchar *param, const GValue *value)
 {
@@ -166,12 +176,32 @@ grl_config_set (GrlConfig *config, const gchar *param, const GValue *value)
   }
 }
 
+/**
+ * grl_config_set_string:
+ * @config: the config instance
+ * @param: a string type parameter
+ * @value: a value
+ *
+ * Set @param @value.
+ *
+ * Since: 0.1.5
+ **/
 void
 grl_config_set_string (GrlConfig *config, const gchar *param, const gchar *value)
 {
   g_key_file_set_string (config->priv->config, GROUP_NAME, param, value);
 }
 
+/**
+ * grl_config_set_int:
+ * @config: the config instance
+ * @param: an integer type parameter
+ * @value: a value
+ *
+ * Set @param @value.
+ *
+ * Since: 0.1.5
+ **/
 void
 grl_config_set_int (GrlConfig *config, const gchar *param, gint value)
 {
@@ -179,18 +209,49 @@ grl_config_set_int (GrlConfig *config, const gchar *param, gint value)
 }
 
 
+/**
+ * grl_config_set_float:
+ * @config: the config instance
+ * @param: a float type parameter
+ * @value: a value
+ *
+ * Set @param @value.
+ *
+ * Since: 0.1.5
+ **/
 void
 grl_config_set_float (GrlConfig *config, const gchar *param, gfloat value)
 {
   g_key_file_set_double (config->priv->config, GROUP_NAME, param, (gdouble) value);
 }
 
+/**
+ * grl_config_set_boolean:
+ * @config: the config instance
+ * @param: a boolean type parameter
+ * @value: a value
+ *
+ * Set @param @value.
+ *
+ * Since: 0.1.8
+ **/
 void
 grl_config_set_boolean (GrlConfig *config, const gchar *param, gboolean value)
 {
   g_key_file_set_boolean (config->priv->config, GROUP_NAME, param, value);
 }
 
+/**
+ * grl_config_set_binary:
+ * @config: the config instance
+ * @param: a binary type parameter
+ * @blob: a base64 encoded binary value
+ * @size: size of @value
+ *
+ * Set @param value.
+ *
+ * Since: 0.1.9
+ **/
 void
 grl_config_set_binary (GrlConfig *config, const gchar *param, const guint8 *blob, gsize size)
 {
@@ -199,6 +260,15 @@ grl_config_set_binary (GrlConfig *config, const gchar *param, const guint8 *blob
   g_free (encoded);
 }
 
+/**
+ * grl_config_get_string:
+ * @config: the config instance
+ * @param: a string type paramter
+ *
+ * Returns: @param value
+ *
+ * Since: 0.1.5
+ **/
 gchar *
 grl_config_get_string (GrlConfig *config, const gchar *param)
 {
@@ -206,6 +276,15 @@ grl_config_get_string (GrlConfig *config, const gchar *param)
   return g_key_file_get_string (config->priv->config, GROUP_NAME, param, NULL);
 }
 
+/**
+ * grl_config_get_int:
+ * @config: the config instance
+ * @param: an integer type parameter
+ *
+ * Returns: @param value
+ *
+ * Since: 0.1.5
+ **/
 gint
 grl_config_get_int (GrlConfig *config, const gchar *param)
 {
@@ -213,6 +292,15 @@ grl_config_get_int (GrlConfig *config, const gchar *param)
   return g_key_file_get_integer (config->priv->config, GROUP_NAME, param, NULL);
 }
 
+/**
+ * grl_config_get_float:
+ * @config: the config instance
+ * @param: a float type parameter
+ *
+ * Returns: @param value
+ *
+ * Since: 0.1.5
+ **/
 gfloat
 grl_config_get_float (GrlConfig *config, const gchar *param)
 {
@@ -221,6 +309,15 @@ grl_config_get_float (GrlConfig *config, const gchar *param)
                                          param, NULL);
 }
 
+/**
+ * grl_config_get_boolean:
+ * @config: the config instance
+ * @param: a boolean type parameter
+ *
+ * Returns: @param value
+ *
+ * Since: 0.1.8
+ **/
 gboolean
 grl_config_get_boolean (GrlConfig *config, const gchar *param)
 {
@@ -228,6 +325,19 @@ grl_config_get_boolean (GrlConfig *config, const gchar *param)
   return g_key_file_get_boolean (config->priv->config, GROUP_NAME, param, NULL);
 }
 
+/**
+ * grl_config_get_binary:
+ * @config: the config instance
+ * @param: a binary type parameter
+ * @size: (allow-none): place for size of value
+ *
+ * Gets the value of @param encoded as base64. If @size is not %NULL, it puts
+ * there the size of the value.
+ *
+ * Returns: @param value
+ *
+ * Since: 0.1.9
+ **/
 guint8 *
 grl_config_get_binary (GrlConfig *config, const gchar *param, gsize *size)
 {
diff --git a/src/grl-caps.c b/src/grl-caps.c
index 8c1f660..d23cac0 100644
--- a/src/grl-caps.c
+++ b/src/grl-caps.c
@@ -164,6 +164,12 @@ grl_caps_test_option (GrlCaps *caps, const gchar *key, const GValue *value)
   return FALSE;
 }
 
+/**
+ * grl_caps_get_type_filter:
+ * @caps: a #GrlCaps instance
+ *
+ * Returns: the supported #GrlTypeFilter
+ **/
 GrlTypeFilter
 grl_caps_get_type_filter (GrlCaps *caps)
 {
@@ -172,6 +178,13 @@ grl_caps_get_type_filter (GrlCaps *caps)
   return caps->priv->type_filter;
 }
 
+/**
+ * grl_caps_set_type_filter:
+ * @caps: a #GrlCaps instance
+ * @filter: a #GrlTypefilter
+ *
+ * Sets the supported filter capability.
+ **/
 void
 grl_caps_set_type_filter (GrlCaps *caps, GrlTypeFilter filter)
 {
@@ -211,6 +224,15 @@ grl_caps_set_key_filter (GrlCaps *caps, GList *keys)
   caps->priv->key_filter = g_list_copy (keys);
 }
 
+/**
+ * grl_caps_is_key_filter:
+ * @caps: a #GrlCaps instance
+ * @key: a #GrlKeyID
+ *
+ * Checks if @key is supported for filtering in @caps.
+ *
+ * Returns: %TRUE if @key can be used for filtering
+ **/
 gboolean
 grl_caps_is_key_filter (GrlCaps *caps, GrlKeyID key)
 {
@@ -255,6 +277,15 @@ grl_caps_set_key_range_filter (GrlCaps *caps, GList *keys)
   caps->priv->key_range_filter = g_list_copy (keys);
 }
 
+/**
+ * grl_caps_is_key_range_filter:
+ * @caps: a #grlCaps instance
+ * @key: a #GrlKeyID
+ *
+ * Checks if @key is supported for filtering by range in @caps.
+ *
+ * Returns: %TRUE if @key can be used for filtering
+ **/
 gboolean
 grl_caps_is_key_range_filter (GrlCaps *caps, GrlKeyID key)
 {
diff --git a/src/grl-log.c b/src/grl-log.c
index b97eaa8..149933b 100644
--- a/src/grl-log.c
+++ b/src/grl-log.c
@@ -141,6 +141,14 @@ _grl_log_domain_free_internal (GrlLogDomain *domain)
   g_slice_free (GrlLogDomain, domain);
 }
 
+/**
+ * grl_log_domain_free:
+ * @domain: a #GrlLogDomain
+ *
+ * Releases @domain.
+ *
+ * Since: 0.1.7
+ **/
 void
 grl_log_domain_free (GrlLogDomain *domain)
 {
@@ -296,6 +304,18 @@ grl_log_valist (GrlLogDomain *domain,
   g_free (message);
 }
 
+/**
+ * grl_log:
+ * @domain: a domain
+ * @level: log level
+ * @strloc: string, usually line of code where function is invoked
+ * @format: log message
+ * @...: parameters to insert in the log message
+ *
+ * Send a log message.
+ *
+ * Since: 0.1.7
+ **/
 void
 grl_log (GrlLogDomain *domain,
          GrlLogLevel   level,
diff --git a/src/grl-operation-options.c b/src/grl-operation-options.c
index 8d11921..0b7dbc0 100644
--- a/src/grl-operation-options.c
+++ b/src/grl-operation-options.c
@@ -504,6 +504,16 @@ grl_operation_options_get_type_filter (GrlOperationOptions *options)
   return TYPE_FILTER_DEFAULT;
 }
 
+/**
+ * grl_operation_options_set_key_filter_value:
+ * @options: a #GrlOperationOptions instance
+ * @key: a #GrlKeyID
+ * @value: a #GValue
+ *
+ * Set filter as "@key == @value".
+ *
+ * Returns: %TRUE on success
+ **/
 gboolean
 grl_operation_options_set_key_filter_value (GrlOperationOptions *options,
                                             GrlKeyID key,
@@ -536,6 +546,25 @@ grl_operation_options_set_key_filter_value (GrlOperationOptions *options,
   return ret;
 }
 
+/**
+ * grl_operation_options_set_key_filters:
+ * @options: a #GrlOperationOptions instance
+ * @...: pairs of #GrlKeyID, value
+ *
+ * Set filter as "k1 == v1 AND k2 == v2 AND ..."
+ *
+ * <example>
+ *  Elements from album "Frozen" with a bitrate of 256kbs.
+ *  <programlisting>
+ *   grl_operation_options_set_key_filters (my_options,
+ *                                          GRL_METADATA_KEY_ALBUM, "Frozen",
+ *                                          GRL_METADATA_KEY_BITRATE, 256,
+ *                                          NULL);
+ *  </programlisting>
+ * </example>
+ *
+ * Returns: %TRUE on success
+ **/
 gboolean
 grl_operation_options_set_key_filters (GrlOperationOptions *options,
                                        ...)
@@ -631,6 +660,21 @@ grl_operation_options_get_key_filter_list (GrlOperationOptions *options)
   return g_hash_table_get_keys (options->priv->key_filter);
 }
 
+/**
+ * grl_operation_options_set_key_range_filter_value:
+ * @options: a #GrlOperationOptions instance
+ * @key: a #GrlKeyId
+ * @min_value: (in) (allow-none): minimum value for range
+ * @max_value: (in) (allow-none): maximum value for range
+ *
+ * Set filter as "@min_value <= @key <= @max_value".
+ *
+ * If @min_value is %NULL, then filter is "@key <= @max_value".
+ *
+ * If @max_value is %NULL, then filter is "@key >= @min_value".
+ *
+ * Returns: %TRUE on success
+ **/
 gboolean
 grl_operation_options_set_key_range_filter_value (GrlOperationOptions *options,
                                                   GrlKeyID key,
@@ -656,6 +700,27 @@ grl_operation_options_set_key_range_filter_value (GrlOperationOptions *options,
   return ret;
 }
 
+/**
+ * grl_operation_options_set_key_range_filter:
+ * @options: a #GrlOperationOptions instance
+ * @...: triplets of #GrlKeyID, minvalue, maxvalue
+ *
+ * Set filter as "min1 <= k1 <= max1 AND min2 <= k2 <= max2 AND ..."
+ *
+ * The range can be open if some of the minX, maxX values are %NULL.
+
+ * <example>
+ *  Album must start with "T" and the bitrate should be 256kbs or greater.
+ *  <programlisting>
+ *   grl_operation_options_set_key_range_filters (my_options,
+ *                                                GRL_METADATA_KEY_ALBUM, "Ta", "Tz",
+ *                                                GRL_METADATA_KEY_BITRATE, 256, NULL,
+ *                                                NULL);
+ *  </programlisting>
+ * </example>
+ *
+ * Returns: %TRUE on success
+ **/
 gboolean
 grl_operation_options_set_key_range_filter (GrlOperationOptions *options,
                                             ...)
@@ -728,6 +793,16 @@ grl_operation_options_set_key_range_filter (GrlOperationOptions *options,
   return success;
 }
 
+/**
+ * grl_operation_options_get_key_range_filter:
+ * @options: a #GrlOperationOptions instance
+ * @key: a #GrlkeyId
+ * @min_value: (out) (allow-none): the minimum value for the range
+ * @max_value: (out) (allow-none): the maximum value for the range
+ *
+ * Stores the limits of the range in the filter for @key in @min_value and
+ * @max_value. If some of the values has no limit, it will set a %NULL.
+ **/
 void
 grl_operation_options_get_key_range_filter (GrlOperationOptions *options,
                                             GrlKeyID key,
diff --git a/src/grl-operation.c b/src/grl-operation.c
index a0baa36..05837cb 100644
--- a/src/grl-operation.c
+++ b/src/grl-operation.c
@@ -86,10 +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 90e5a51..36750c7 100644
--- a/src/grl-plugin.c
+++ b/src/grl-plugin.c
@@ -147,15 +147,15 @@ grl_plugin_get_property (GObject *object,
   }
 }
 
-/* ================ API ================ */
+/* ============ PRIVATE API ============ */
 
-/**
+/*
  * grl_plugin_set_optional_info:
  * @plugin: a plugin
  * @info: a hashtable containing optional information
  *
  * Sets the optional information. Takes ownership of @info table.
- **/
+ */
 void
 grl_plugin_set_optional_info (GrlPlugin *plugin,
                               GHashTable *info)
@@ -166,13 +166,13 @@ grl_plugin_set_optional_info (GrlPlugin *plugin,
   plugin->priv->optional_info = info;
 }
 
-/**
+/*
  * grl_plugin_set_load_func:
  * @plugin: a plugin
  * @load_function: a function
  *
  * Sets the function to be executed when plugin is loaded
- **/
+ */
 void
 grl_plugin_set_load_func (GrlPlugin *plugin,
                           gpointer load_function)
@@ -182,13 +182,13 @@ grl_plugin_set_load_func (GrlPlugin *plugin,
   plugin->priv->load_func = load_function;
 }
 
-/**
+/*
  * grl_plugin_set_unload_func:
  * @plugin: a plugin
  * @unload_function: a function
  *
  * Sets the function to be executed when plugin is unloaded
- **/
+ */
 void
 grl_plugin_set_unload_func (GrlPlugin *plugin,
                             gpointer unload_function)
@@ -198,7 +198,7 @@ grl_plugin_set_unload_func (GrlPlugin *plugin,
   plugin->priv->unload_func = unload_function;
 }
 
-/**
+/*
  * grl_plugin_load:
  * @plugin: a plugin
  * @configurations: (element-type Grl.Config): a list of configurations
@@ -206,7 +206,7 @@ grl_plugin_set_unload_func (GrlPlugin *plugin,
  * Load the plugin
  *
  * Returns: @TRUE if loaded was successful
- **/
+ */
 gboolean
 grl_plugin_load (GrlPlugin *plugin,
                  GList *configurations)
@@ -231,12 +231,12 @@ grl_plugin_load (GrlPlugin *plugin,
   return TRUE;
 }
 
-/**
+/*
  * grl_plugin_unload:
  * @plugin: a plugin
  *
  * Unloads the plugin
- **/
+ */
 void
 grl_plugin_unload (GrlPlugin *plugin)
 {
@@ -250,6 +250,82 @@ grl_plugin_unload (GrlPlugin *plugin)
   g_object_notify_by_pspec (G_OBJECT (plugin), properties[PROP_LOADED]);
 }
 
+/*
+ * grl_plugin_set_id:
+ * @plugin: a plugin
+ * @id: plugin identifier
+ *
+ * Sets the id of the plugin
+ */
+void
+grl_plugin_set_id (GrlPlugin *plugin,
+                   const gchar *id)
+{
+  g_return_if_fail (GRL_IS_PLUGIN (plugin));
+
+  if (plugin->priv->id) {
+    g_free (plugin->priv->id);
+  }
+  plugin->priv->id = g_strdup (id);
+}
+
+/*
+ * grl_plugin_set_filename:
+ * @plugin: a plugin
+ * @filename: a filename
+ *
+ * Sets the filename containing the plugin
+ */
+void
+grl_plugin_set_filename (GrlPlugin *plugin,
+                         const gchar *filename)
+{
+  g_return_if_fail (GRL_IS_PLUGIN (plugin));
+
+  if (plugin->priv->filename) {
+    g_free (plugin->priv->filename);
+  }
+
+  plugin->priv->filename = g_strdup (filename);
+}
+
+/*
+ * grl_plugin_set_module:
+ * @plugin: a plugin
+ * @module: a module
+ *
+ * Sets the module of the plugin
+ */
+void
+grl_plugin_set_module (GrlPlugin *plugin,
+                       GModule *module)
+{
+  g_return_if_fail (GRL_IS_PLUGIN (plugin));
+  plugin->priv->module = module;
+}
+
+/*
+ * grl_plugin_set_info:
+ * @plugin: a plugin
+ * @key: key representing information about this plugin
+ * @value: the information itself
+ *
+ * Sets the information of the @plugin that is associaed with the given @key.
+ */
+void
+grl_plugin_set_info (GrlPlugin *plugin,
+                     const gchar *key,
+                     const gchar *value)
+{
+  g_return_if_fail (GRL_IS_PLUGIN (plugin));
+
+  g_hash_table_insert (plugin->priv->optional_info,
+                       g_strdup (key),
+                       g_strdup (value));
+}
+
+/* ============ PUBLIC API ============= */
+
 /**
  * grl_plugin_get_name:
  * @plugin: a plugin
@@ -351,25 +427,6 @@ grl_plugin_get_id (GrlPlugin *plugin)
 }
 
 /**
- * grl_plugin_set_id:
- * @plugin: a plugin
- * @id: plugin identifier
- *
- * Sets the id of the plugin
- **/
-void
-grl_plugin_set_id (GrlPlugin *plugin,
-                   const gchar *id)
-{
-  g_return_if_fail (GRL_IS_PLUGIN (plugin));
-
-  if (plugin->priv->id) {
-    g_free (plugin->priv->id);
-  }
-  plugin->priv->id = g_strdup (id);
-}
-
-/**
  * grl_plugin_get_filename:
  * @plugin: a plugin
  *
@@ -386,26 +443,6 @@ grl_plugin_get_filename (GrlPlugin *plugin)
 }
 
 /**
- * grl_plugin_set_filename:
- * @plugin: a plugin
- * @filename: a filename
- *
- * Sets the filename containing the plugin
- **/
-void
-grl_plugin_set_filename (GrlPlugin *plugin,
-                         const gchar *filename)
-{
-  g_return_if_fail (GRL_IS_PLUGIN (plugin));
-
-  if (plugin->priv->filename) {
-    g_free (plugin->priv->filename);
-  }
-
-  plugin->priv->filename = g_strdup (filename);
-}
-
-/**
  * grl_plugin_get_module: (skip)
  * @plugin: a plugin
  *
@@ -420,14 +457,6 @@ grl_plugin_get_module (GrlPlugin *plugin)
   return plugin->priv->module;
 }
 
-void
-grl_plugin_set_module (GrlPlugin *plugin,
-                       GModule *module)
-{
-  g_return_if_fail (GRL_IS_PLUGIN (plugin));
-  plugin->priv->module = module;
-}
-
 /**
  * grl_plugin_get_info_keys:
  * @plugin: a plugin
@@ -474,26 +503,6 @@ grl_plugin_get_info (GrlPlugin *plugin, const gchar *key)
 }
 
 /**
- * grl_plugin_set_info:
- * @plugin: a plugin
- * @key: key representing information about this plugin
- * @value: the information itself
- *
- * Sets the information of the @plugin that is associaed with the given @key.
- **/
-void
-grl_plugin_set_info (GrlPlugin *plugin,
-                     const gchar *key,
-                     const gchar *value)
-{
-  g_return_if_fail (GRL_IS_PLUGIN (plugin));
-
-  g_hash_table_insert (plugin->priv->optional_info,
-                       g_strdup (key),
-                       g_strdup (value));
-}
-
-/**
  * grl_plugin_get_sources:
  * @plugin: a plugin
  *
diff --git a/src/grl-range-value.c b/src/grl-range-value.c
index fcb6c9d..1510f96 100644
--- a/src/grl-range-value.c
+++ b/src/grl-range-value.c
@@ -20,12 +20,9 @@
  *
  */
 
-/**
- * SECTION:grl-range-value
- * @short_description: helpers to use Range Values
- *
- * This module provides helper functions to use Range Values easily. Inspired by
- * libsoup's soup-value-utils:
+/*
+ * This module provides helper functions to use Range Values easily.
+ * Inspired by libsoup's soup-value-utils:
  * http://git.gnome.org/browse/libsoup/tree/libsoup/soup-value-utils.c
  *
  */
@@ -69,11 +66,11 @@ grl_range_value_free (GrlRangeValue *range)
   g_slice_free (GrlRangeValue, range);
 }
 
-/**
- * grl_range_value_hashtable_new: (skip)
+/*
+ * grl_range_value_hashtable_new:
  *
  * Returns: a #GHashTable
- **/
+ */
 GHashTable *
 grl_range_value_hashtable_new (void)
 {
diff --git a/src/grl-registry.c b/src/grl-registry.c
index 6712b4b..595c2d3 100644
--- a/src/grl-registry.c
+++ b/src/grl-registry.c
@@ -522,7 +522,7 @@ key_id_handler_get_name (struct KeyIDHandler *handler, GrlKeyID key)
   return NULL;
 }
 
-/**
+/*
  * key_id_handler_add:
  * @handler: the handler
  * @key: a specific key for system keys, or GRL_METADATA_KEY_INVALID for it to
@@ -581,7 +581,7 @@ key_id_handler_get_all_keys (struct KeyIDHandler *handler)
 
 /* ================ PRIVATE API ================ */
 
-/**
+/*
  * grl_registry_restrict_plugins:
  * @registry: the registry instance
  * @plugins: a @NULL-terminated array of plugins identifiers
diff --git a/src/grl-value-helper.c b/src/grl-value-helper.c
index 5507ec5..c9ff7b4 100644
--- a/src/grl-value-helper.c
+++ b/src/grl-value-helper.c
@@ -20,10 +20,7 @@
  *
  */
 
-/**
- * SECTION:grl-value-helper
- * @short_description: helpers to use GValue
- *
+/*
  * This module provides helper functions to use GValues easily. Inspired by
  * libsoup's soup-value-utils:
  * http://git.gnome.org/browse/libsoup/tree/libsoup/soup-value-utils.c
@@ -33,9 +30,6 @@
 #include <grl-value-helper.h>
 
 
-/**
- * grl_g_value_new: (skip)
- */
 GValue *
 grl_g_value_new (GType g_type)
 {
@@ -47,9 +41,6 @@ grl_g_value_new (GType g_type)
   return value;
 }
 
-/**
- * grl_g_value_free: (skip)
- */
 void
 grl_g_value_free (GValue *value)
 {
@@ -57,9 +48,7 @@ grl_g_value_free (GValue *value)
   g_slice_free (GValue, value);
 }
 
-/**
- * grl_g_value_hashtable_new: (skip)
- *
+/*
  * Returns: a new hash table made to contain GValues.
  */
 GHashTable *
@@ -68,18 +57,12 @@ 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)
 {
   return g_hash_table_new_full (g_direct_hash, g_direct_equal, NULL, (GDestroyNotify)grl_g_value_free);
 }
 
-/**
- * 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]