[grilo] doc: Add API information

From: Juan A. Suarez Romero <jasuarez src gnome org>
To: commits-list gnome org
Cc:
Subject: [grilo] doc: Add API information
Date: Mon, 13 Aug 2012 09:12:57 +0000 (UTC)
commit c284ab8df6179705a36cfcc57575a8236301a24e
Author: Juan A. Suarez Romero <jasuarez igalia com>
Date:   Mon Aug 13 08:15:26 2012 +0000

    doc: Add API information
    
    Annotate "Since:" tag.

 src/data/grl-data.c         |   10 +++++
 src/data/grl-media.c        |   13 +++++--
 src/data/grl-related-keys.c |    4 ++
 src/grl-caps.c              |   19 ++++++++++
 src/grl-metadata-key.c      |    4 ++
 src/grl-multiple.c          |    6 ++--
 src/grl-operation-options.c |   38 +++++++++++++++++++-
 src/grl-plugin.c            |   26 +++++++++++++
 src/grl-registry.c          |   54 ++++++++++++++++++----------
 src/grl-source.c            |   83 +++++++++++++++++++++++++++++++++++++++++-
 src/grl-util.c              |    1 +
 11 files changed, 230 insertions(+), 28 deletions(-)
---
diff --git a/src/data/grl-data.c b/src/data/grl-data.c
index 3c07396..fcf93f2 100644
--- a/src/data/grl-data.c
+++ b/src/data/grl-data.c
@@ -365,6 +365,8 @@ grl_data_get_float (GrlData *data, GrlKeyID key)
  *
  * Sets the first binary value associated with @key in @data. If @key already
  * has a first value old value is replaced by the new one.
+ *
+ * Since: 0.1.9
  **/
 void
 grl_data_set_binary (GrlData *data, GrlKeyID key, const guint8 *buf, gsize size)
@@ -398,6 +400,8 @@ grl_data_set_binary (GrlData *data, GrlKeyID key, const guint8 *buf, gsize size)
  *
  * Returns: buffer location associated with the @key, or %NULL in other case. If
  * successful @size will be set the to the buffer size.
+ *
+ * Since: 0.1.9
  **/
 const guint8 *
 grl_data_get_binary(GrlData *data, GrlKeyID key, gsize *size)
@@ -425,6 +429,8 @@ grl_data_get_binary(GrlData *data, GrlKeyID key, gsize *size)
  *
  * Sets the first boxed value associated with @key in @data. If @key already
  * has a value, the old value is freed and the new one is set.
+ *
+ * Since: 0.2.0
  **/
 void
 grl_data_set_boxed (GrlData *data, GrlKeyID key, gconstpointer boxed)
@@ -451,6 +457,8 @@ grl_data_set_boxed (GrlData *data, GrlKeyID key, gconstpointer boxed)
  * Returns: (transfer none): the boxed instance associated with @key if
  * possible, or %NULL in other cases. The caller should not change nor free the
  * value.
+ *
+ * Since: 0.2.0
  **/
 gpointer
 grl_data_get_boxed (GrlData *data, GrlKeyID key)
@@ -707,6 +715,8 @@ grl_data_add_binary (GrlData *data,
  * @boxed: the new value
  *
  * Appends a new boxed value for @key in @data.
+ *
+ * Since: 0.2.0
  **/
 void
 grl_data_add_boxed (GrlData *data,
diff --git a/src/data/grl-media.c b/src/data/grl-media.c
index 7a422b8..a545e55 100644
--- a/src/data/grl-media.c
+++ b/src/data/grl-media.c
@@ -677,6 +677,8 @@ grl_media_set_duration (GrlMedia *media, gint duration)
  * @date: the date
  *
  * Set the publication date of @media.
+ *
+ * Since: 0.2.0
  */
 void
 grl_media_set_publication_date (GrlMedia *media, const GDateTime *date)
@@ -693,7 +695,7 @@ grl_media_set_publication_date (GrlMedia *media, const GDateTime *date)
   *
   * Set the creation_date of the media
   *
-  * Since: 0.1.12
+  * Since: 0.2.0
   */
 void
 grl_media_set_creation_date (GrlMedia *media,
@@ -711,6 +713,7 @@ grl_media_set_creation_date (GrlMedia *media,
   *
   * Set the modification date of the media
   *
+  * Since: 0.2.0
   */
 void
 grl_media_set_modification_date (GrlMedia *media,
@@ -1143,7 +1146,7 @@ grl_media_get_duration (GrlMedia *media)
  *
  * Returns: (transfer none): the publication date of @media (owned by @media).
  *
- * Since: 0.1.4
+ * Since: 0.2.0
  */
 GDateTime *
 grl_media_get_publication_date (GrlMedia *media)
@@ -1158,7 +1161,7 @@ grl_media_get_publication_date (GrlMedia *media)
  *
  * Returns: (transfer none): date when media was created (owned by @media).
  *
- * Since: 0.1.12
+ * Since: 0.2.0
  */
 GDateTime *
 grl_media_get_creation_date (GrlMedia *media)
@@ -1171,6 +1174,8 @@ grl_media_get_creation_date (GrlMedia *media)
  * @media: the media
  *
  * Returns: (transfer none):date when the media was last modified (owned by @media).
+ *
+ * Since: 0.2.0
  */
 GDateTime *
 grl_media_get_modification_date (GrlMedia *media)
@@ -1378,6 +1383,8 @@ grl_media_get_license (GrlMedia *media)
  *
  * Returns: the start time of the logical media resource inside the
  *          file containing it, in seconds.
+ *
+ * Since: 0.1.19
  */
 gfloat
 grl_media_get_start_time (GrlMedia *media)
diff --git a/src/data/grl-related-keys.c b/src/data/grl-related-keys.c
index fdc8505..6c9d783 100644
--- a/src/data/grl-related-keys.c
+++ b/src/data/grl-related-keys.c
@@ -490,6 +490,8 @@ grl_related_keys_get_binary (GrlRelatedKeys *relkeys,
  *
  * Sets the value associated with @key into @relkeys. @key must have been
  * registered as a boxed-type key. Old value is freed and the new one is set.
+ *
+ * Since: 0.2.0
  */
 void
 grl_related_keys_set_boxed (GrlRelatedKeys *relkeys,
@@ -518,6 +520,8 @@ grl_related_keys_set_boxed (GrlRelatedKeys *relkeys,
  * Returns: (transfer none): the #GBoxed value associated with @key if
  * possible, or %NULL in other case. The caller should not change nor free the
  * value.
+ *
+ * Since: 0.2.0
  */
 gconstpointer
 grl_related_keys_get_boxed (GrlRelatedKeys *relkeys,
diff --git a/src/grl-caps.c b/src/grl-caps.c
index d23cac0..ace6c27 100644
--- a/src/grl-caps.c
+++ b/src/grl-caps.c
@@ -115,6 +115,8 @@ grl_caps_class_init (GrlCapsClass *self_class)
  * Creates a new caps object.
  *
  * Returns: a new caps object.
+ *
+ * Since: 0.2.0
  **/
 GrlCaps *
 grl_caps_new (void)
@@ -132,6 +134,7 @@ grl_caps_new (void)
  *
  * Returns: %TRUE if (@key, @value) obey to @caps, %FALSE otherwise.
  *
+ * Since: 0.2.0
  */
 gboolean
 grl_caps_test_option (GrlCaps *caps, const gchar *key, const GValue *value)
@@ -169,6 +172,8 @@ grl_caps_test_option (GrlCaps *caps, const gchar *key, const GValue *value)
  * @caps: a #GrlCaps instance
  *
  * Returns: the supported #GrlTypeFilter
+ *
+ * Since: 0.2.0
  **/
 GrlTypeFilter
 grl_caps_get_type_filter (GrlCaps *caps)
@@ -184,6 +189,8 @@ grl_caps_get_type_filter (GrlCaps *caps)
  * @filter: a #GrlTypefilter
  *
  * Sets the supported filter capability.
+ *
+ * Since: 0.2.0
  **/
 void
 grl_caps_set_type_filter (GrlCaps *caps, GrlTypeFilter filter)
@@ -198,6 +205,8 @@ grl_caps_set_type_filter (GrlCaps *caps, GrlTypeFilter filter)
  * @caps: a #GrlCaps instance
  *
  * Returns: (transfer none) (element-type GrlKeyID):
+ *
+ * Since: 0.2.0
  */
 GList *
 grl_caps_get_key_filter (GrlCaps *caps)
@@ -211,6 +220,8 @@ grl_caps_get_key_filter (GrlCaps *caps)
  * grl_caps_set_key_filter:
  * @caps: a #GrlCaps instance
  * @keys: (transfer none) (element-type GrlKeyID):
+ *
+ * Since: 0.2.0
  */
 void
 grl_caps_set_key_filter (GrlCaps *caps, GList *keys)
@@ -232,6 +243,8 @@ grl_caps_set_key_filter (GrlCaps *caps, GList *keys)
  * Checks if @key is supported for filtering in @caps.
  *
  * Returns: %TRUE if @key can be used for filtering
+ *
+ * Since: 0.2.0
  **/
 gboolean
 grl_caps_is_key_filter (GrlCaps *caps, GrlKeyID key)
@@ -251,6 +264,8 @@ grl_caps_is_key_filter (GrlCaps *caps, GrlKeyID key)
  * @caps: a #GrlCaps instance
  *
  * Returns: (transfer none) (element-type GrlKeyID):
+ *
+ * Since: 0.2.0
  */
 GList *
 grl_caps_get_key_range_filter (GrlCaps *caps)
@@ -264,6 +279,8 @@ grl_caps_get_key_range_filter (GrlCaps *caps)
  * grl_caps_set_key_range_filter:
  * @caps: a #GrlCaps instance
  * @keys: (transfer none) (element-type GrlKeyID):
+ *
+ * Since: 0.2.0
  */
 void
 grl_caps_set_key_range_filter (GrlCaps *caps, GList *keys)
@@ -285,6 +302,8 @@ grl_caps_set_key_range_filter (GrlCaps *caps, GList *keys)
  * Checks if @key is supported for filtering by range in @caps.
  *
  * Returns: %TRUE if @key can be used for filtering
+ *
+ * Since: 0.2.0
  **/
 gboolean
 grl_caps_is_key_range_filter (GrlCaps *caps, GrlKeyID key)
diff --git a/src/grl-metadata-key.c b/src/grl-metadata-key.c
index 5c47143..3a3b136 100644
--- a/src/grl-metadata-key.c
+++ b/src/grl-metadata-key.c
@@ -524,6 +524,8 @@ grl_metadata_key_get_desc (GrlKeyID key)
  * Retrieves the expected type for values associated with this key
  *
  * Returns: the expected value type
+ *
+ * Since: 0.2.0
  **/
 GType grl_metadata_key_get_type (GrlKeyID key)
 {
@@ -545,6 +547,8 @@ GType grl_metadata_key_get_type (GrlKeyID key)
  * to finalize them.
  *
  * Returns: a #GList
+ *
+ * Since: 0.2.0
  **/
 GList *
 grl_metadata_key_list_new(GrlKeyID first_key, ...)
diff --git a/src/grl-multiple.c b/src/grl-multiple.c
index 0e96396..66f8817 100644
--- a/src/grl-multiple.c
+++ b/src/grl-multiple.c
@@ -511,7 +511,7 @@ media_from_uri_cb (GrlSource *source,
  *
  * Returns: the operation identifier
  *
- * Since: 0.1.6
+ * Since: 0.2.0
  */
 guint
 grl_multiple_search (const GList *sources,
@@ -610,7 +610,7 @@ multiple_search_cancel_cb (struct MultipleSearchData *msd)
  *
  * Returns: (element-type Grl.Media) (transfer full): a list with #GrlMedia elements
  *
- * Since: 0.1.6
+ * Since: 0.2.0
  */
 GList *
 grl_multiple_search_sync (const GList *sources,
@@ -661,7 +661,7 @@ grl_multiple_search_sync (const GList *sources,
  *
  * This method is asynchronous.
  *
- * Since: 0.1.7
+ * Since: 0.2.0
  */
 void
 grl_multiple_get_media_from_uri (const gchar *uri,
diff --git a/src/grl-operation-options.c b/src/grl-operation-options.c
index 0b7dbc0..c878732 100644
--- a/src/grl-operation-options.c
+++ b/src/grl-operation-options.c
@@ -161,6 +161,8 @@ key_range_filter_dup (GrlKeyID key, GrlRangeValue *value, GHashTable *destinatio
  * Creates a new GrlOperationOptions object.
  *
  * Returns: a new GrlOperationOptions instance.
+ *
+ * Since: 0.2.0
  */
 GrlOperationOptions *
 grl_operation_options_new (GrlCaps *caps)
@@ -190,6 +192,8 @@ grl_operation_options_new (GrlCaps *caps)
  * #GrlOperationOptions instance that was created with %NULL caps.
  *
  * Returns: %TRUE if @options obey to @caps, %FALSE otherwise.
+ *
+ * Since: 0.2.0
  */
 gboolean
 grl_operation_options_obey_caps (GrlOperationOptions *options,
@@ -270,6 +274,8 @@ grl_operation_options_obey_caps (GrlOperationOptions *options,
  *
  * Returns: (transfer full): a new #GrlOperationOptions instance with its values being copies of
  * the values of @options.
+ *
+ * Since: 0.2.0
  */
 GrlOperationOptions *
 grl_operation_options_copy (GrlOperationOptions *options)
@@ -301,6 +307,7 @@ grl_operation_options_copy (GrlOperationOptions *options)
  *
  * Returns: whether @key is set in @options.
  *
+ * Since: 0.2.0
  */
 gboolean
 grl_operation_options_key_is_set (GrlOperationOptions *options,
@@ -318,6 +325,8 @@ grl_operation_options_key_is_set (GrlOperationOptions *options,
  * inherent capabilities of @options.
  *
  * Returns: %TRUE if @skip could be set, %FALSE otherwise.
+ *
+ * Since: 0.2.0
  */
 gboolean
 grl_operation_options_set_skip (GrlOperationOptions *options,
@@ -344,6 +353,7 @@ grl_operation_options_set_skip (GrlOperationOptions *options,
  *
  * Returns: the value of the skip option, or a default value if it is not set.
  *
+ * Since: 0.2.0
  */
 guint
 grl_operation_options_get_skip (GrlOperationOptions *options)
@@ -366,6 +376,8 @@ grl_operation_options_get_skip (GrlOperationOptions *options)
  * the inherent capabilities of @options.
  *
  * Returns: %TRUE if @count could be set, %FALSE otherwise.
+ *
+ * Since: 0.2.0
  */
 gboolean
 grl_operation_options_set_count (GrlOperationOptions *options, gint count)
@@ -391,7 +403,7 @@ grl_operation_options_set_count (GrlOperationOptions *options, gint count)
  *
  * Returns: the value of the count option, or a default value if it is not set.
  *
- *
+ * Since: 0.2.0
  */
 gint
 grl_operation_options_get_count (GrlOperationOptions *options)
@@ -416,6 +428,7 @@ grl_operation_options_get_count (GrlOperationOptions *options)
  *
  * Returns: %TRUE if @flags could be set, %FALSE otherwise.
  *
+ * Since: 0.2.0
  */
 gboolean
 grl_operation_options_set_flags (GrlOperationOptions *options,
@@ -439,6 +452,7 @@ grl_operation_options_set_flags (GrlOperationOptions *options,
  *
  * Returns: resolution flags of @options.
  *
+ * Since: 0.2.0
  */
 GrlResolutionFlags
 grl_operation_options_get_flags (GrlOperationOptions *options)
@@ -461,6 +475,8 @@ grl_operation_options_get_flags (GrlOperationOptions *options)
  * inherent capabilities of @options.
  *
  * Returns: %TRUE if @flags could be set, %FALSE otherwise
+ *
+ * Since: 0.2.0
  **/
 gboolean
 grl_operation_options_set_type_filter (GrlOperationOptions *options,
@@ -490,6 +506,8 @@ grl_operation_options_set_type_filter (GrlOperationOptions *options,
  *
  *
  * Returns: resolution flags of @options
+ *
+ * Since: 0.2.0
  **/
 GrlTypeFilter
 grl_operation_options_get_type_filter (GrlOperationOptions *options)
@@ -513,6 +531,8 @@ grl_operation_options_get_type_filter (GrlOperationOptions *options)
  * Set filter as "@key == @value".
  *
  * Returns: %TRUE on success
+ *
+ * Since: 0.2.0
  **/
 gboolean
 grl_operation_options_set_key_filter_value (GrlOperationOptions *options,
@@ -564,6 +584,8 @@ grl_operation_options_set_key_filter_value (GrlOperationOptions *options,
  * </example>
  *
  * Returns: %TRUE on success
+ *
+ * Since: 0.2.0
  **/
 gboolean
 grl_operation_options_set_key_filters (GrlOperationOptions *options,
@@ -613,6 +635,8 @@ grl_operation_options_set_key_filters (GrlOperationOptions *options,
  * @filters: (transfer none) (element-type GrlKeyID GValue):
  *
  * Rename to: grl_operation_options_set_key_filters
+ *
+ * Since: 0.2.0
  */
 gboolean
 grl_operation_options_set_key_filter_dictionary (GrlOperationOptions *options,
@@ -639,6 +663,8 @@ grl_operation_options_set_key_filter_dictionary (GrlOperationOptions *options,
  * @key:
  *
  * Returns: (transfer none): the filter
+ *
+ * Since: 0.2.0
  */
 GValue *
 grl_operation_options_get_key_filter (GrlOperationOptions *options,
@@ -653,6 +679,8 @@ grl_operation_options_get_key_filter (GrlOperationOptions *options,
  * @options: a #GrlOperationOptions instance
  *
  * Returns: (transfer container) (element-type GrlKeyID):
+ *
+ * Since: 0.2.0
  */
 GList *
 grl_operation_options_get_key_filter_list (GrlOperationOptions *options)
@@ -674,6 +702,8 @@ grl_operation_options_get_key_filter_list (GrlOperationOptions *options)
  * If @max_value is %NULL, then filter is "@key >= @min_value".
  *
  * Returns: %TRUE on success
+ *
+ * Since: 0.2.0
  **/
 gboolean
 grl_operation_options_set_key_range_filter_value (GrlOperationOptions *options,
@@ -720,6 +750,8 @@ grl_operation_options_set_key_range_filter_value (GrlOperationOptions *options,
  * </example>
  *
  * Returns: %TRUE on success
+ *
+ * Since: 0.2.0
  **/
 gboolean
 grl_operation_options_set_key_range_filter (GrlOperationOptions *options,
@@ -802,6 +834,8 @@ grl_operation_options_set_key_range_filter (GrlOperationOptions *options,
  *
  * 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.
+ *
+ * Since: 0.2.0
  **/
 void
 grl_operation_options_get_key_range_filter (GrlOperationOptions *options,
@@ -835,6 +869,8 @@ grl_operation_options_get_key_range_filter (GrlOperationOptions *options,
  * @options: a #GrlOperationOptions instance
  *
  * Returns: (transfer container) (element-type GrlKeyID):
+ *
+ * Since: 0.2.0
  */
 GList *
 grl_operation_options_get_key_range_filter_list (GrlOperationOptions *options)
diff --git a/src/grl-plugin.c b/src/grl-plugin.c
index 36750c7..7a9c0a7 100644
--- a/src/grl-plugin.c
+++ b/src/grl-plugin.c
@@ -98,6 +98,8 @@ grl_plugin_class_init (GrlPluginClass *plugin_class)
    * GrlPlugin:loaded:
    *
    * @TRUE if plugin is loaded.
+   *
+   * Since: 0.2.0
    */
   g_object_class_install_property (gobject_class,
                                    PROP_LOADED,
@@ -333,6 +335,8 @@ grl_plugin_set_info (GrlPlugin *plugin,
  * Get the name of the plugin
  *
  * Returns: the name of the @plugin
+ *
+ * Since: 0.2.0
  */
 const gchar *
 grl_plugin_get_name (GrlPlugin *plugin)
@@ -347,6 +351,8 @@ grl_plugin_get_name (GrlPlugin *plugin)
  * Get the description of the plugin
  *
  * Returns: the description of the @plugin
+ *
+ * Since: 0.2.0
  */
 const gchar *
 grl_plugin_get_description (GrlPlugin *plugin)
@@ -361,6 +367,8 @@ grl_plugin_get_description (GrlPlugin *plugin)
  * Get the version of the plugin
  *
  * Returns: the version of the @plugin
+ *
+ * Since: 0.2.0
  */
 const gchar *
 grl_plugin_get_version (GrlPlugin *plugin)
@@ -375,6 +383,8 @@ grl_plugin_get_version (GrlPlugin *plugin)
  * Get the license of the plugin
  *
  * Returns: the license of the @plugin
+ *
+ * Since: 0.2.0
  */
 const gchar *
 grl_plugin_get_license (GrlPlugin *plugin)
@@ -389,6 +399,8 @@ grl_plugin_get_license (GrlPlugin *plugin)
  * Get the author of the plugin
  *
  * Returns: the author of the @plugin
+ *
+ * Since: 0.2.0
  */
 const gchar *
 grl_plugin_get_author (GrlPlugin *plugin)
@@ -403,6 +415,8 @@ grl_plugin_get_author (GrlPlugin *plugin)
  * Get the site of the plugin
  *
  * Returns: the site of the @plugin
+ *
+ * Since: 0.2.0
  */
 const gchar *
 grl_plugin_get_site (GrlPlugin *plugin)
@@ -417,6 +431,8 @@ grl_plugin_get_site (GrlPlugin *plugin)
  * Get the id of the plugin
  *
  * Returns: the id of the @plugin
+ *
+ * Since: 0.2.0
  */
 const gchar *
 grl_plugin_get_id (GrlPlugin *plugin)
@@ -433,6 +449,8 @@ grl_plugin_get_id (GrlPlugin *plugin)
  * Get the filename containing the plugin
  *
  * Returns: the filename containing @plugin
+ *
+ * Since: 0.2.0
  */
 const gchar *
 grl_plugin_get_filename (GrlPlugin *plugin)
@@ -449,6 +467,8 @@ grl_plugin_get_filename (GrlPlugin *plugin)
  * Gets the #GModule containing the plugin
  *
  * Returns: a #GModule
+ *
+ * Since: 0.2.0
  **/
 GModule *
 grl_plugin_get_module (GrlPlugin *plugin)
@@ -468,6 +488,8 @@ grl_plugin_get_module (GrlPlugin *plugin)
  * a #GList of strings containing the keys. The content of the list is
  * owned by the plugin and should not be modified or freed. Use g_list_free()
  * when done using the list.
+ *
+ * Since: 0.2.0
  **/
 GList *
 grl_plugin_get_info_keys (GrlPlugin *plugin)
@@ -489,6 +511,8 @@ grl_plugin_get_info_keys (GrlPlugin *plugin)
  * Get the information of the @plugin that is associated with the given key
  *
  * Returns: the information assigned to the given @key or NULL if there is no such information
+ *
+ * Since: 0.2.0
  */
 const gchar *
 grl_plugin_get_info (GrlPlugin *plugin, const gchar *key)
@@ -511,6 +535,8 @@ grl_plugin_get_info (GrlPlugin *plugin, const gchar *key)
  * Returns: (transfer container) (element-type Grl.Source): a #GList of
  * #GrlSource<!-- -->s. The content of the list should not be modified or
  * freed. Use g_list_free() when done using the list.
+ *
+ * Since: 0.2.0
  **/
 GList *
 grl_plugin_get_sources (GrlPlugin *plugin)
diff --git a/src/grl-registry.c b/src/grl-registry.c
index 595c2d3..1a125c6 100644
--- a/src/grl-registry.c
+++ b/src/grl-registry.c
@@ -119,6 +119,8 @@ grl_registry_class_init (GrlRegistryClass *klass)
    * @source: the source that has been added
    *
    * Signals that a source has been added to the registry.
+   *
+   * Since: 0.2.0
    */
   registry_signals[SIG_SOURCE_ADDED] =
     g_signal_new("source-added",
@@ -136,6 +138,8 @@ grl_registry_class_init (GrlRegistryClass *klass)
    * @source: the source that has been removed
    *
    * Signals that a source has been removed from the registry.
+   *
+   * Since: 0.2.0
    */
   registry_signals[SIG_SOURCE_REMOVED] =
     g_signal_new("source-removed",
@@ -625,7 +629,7 @@ grl_registry_restrict_plugins (GrlRegistry *registry,
  *
  * It is NOT MT-safe
  *
- * Since: 0.1.6
+ * Since: 0.2.0
  */
 GrlRegistry *
 grl_registry_get_default (void)
@@ -650,7 +654,7 @@ grl_registry_get_default (void)
  *
  * Returns: %TRUE if success, %FALSE% otherwise.
  *
- * Since: 0.1.7
+ * Since: 0.2.0
  */
 gboolean
 grl_registry_register_source (GrlRegistry *registry,
@@ -696,7 +700,7 @@ grl_registry_register_source (GrlRegistry *registry,
  *
  * Returns: %TRUE if success, %FALSE% otherwise.
  *
- * Since: 0.1.7
+ * Since: 0.2.0
  */
 gboolean
 grl_registry_unregister_source (GrlRegistry *registry,
@@ -736,7 +740,7 @@ grl_registry_unregister_source (GrlRegistry *registry,
  *
  * Set this path as part of default paths to load plugins.
  *
- * Since: 0.1.6
+ * Since: 0.2.0
  **/
 void
 grl_registry_add_directory (GrlRegistry *registry,
@@ -762,7 +766,7 @@ grl_registry_add_directory (GrlRegistry *registry,
  *
  * Returns: %TRUE if the module is loaded correctly
  *
- * Since: 0.1.7
+ * Since: 0.2.0
  */
 gboolean
 grl_registry_load_plugin (GrlRegistry *registry,
@@ -868,7 +872,7 @@ grl_registry_load_plugin (GrlRegistry *registry,
  *
  * Returns: %TRUE if the directory is valid.
  *
- * Since: 0.1.7
+ * Since: 0.2.0
  */
 gboolean
 grl_registry_load_plugin_directory (GrlRegistry *registry,
@@ -905,7 +909,7 @@ grl_registry_load_plugin_directory (GrlRegistry *registry,
  * Returns: %FALSE% is all the configured plugin paths are invalid,
  * %TRUE% otherwise.
  *
- * Since: 0.1.1
+ * Since: 0.2.0
  */
 gboolean
 grl_registry_load_all_plugins (GrlRegistry *registry, GError **error)
@@ -952,7 +956,7 @@ grl_registry_load_all_plugins (GrlRegistry *registry, GError **error)
  *
  * Returns: %TRUE if the plugin is loaded correctly
  *
- * Since: 0.1.14
+ * Since: 0.2.0
  **/
 gboolean
 grl_registry_load_plugin_by_id (GrlRegistry *registry,
@@ -1007,7 +1011,7 @@ grl_registry_load_plugin_by_id (GrlRegistry *registry,
  *
  * Returns: (transfer none): The source found.
  *
- * Since: 0.1.1
+ * Since: 0.2.0
  */
 GrlSource *
 grl_registry_lookup_source (GrlRegistry *registry,
@@ -1033,7 +1037,7 @@ grl_registry_lookup_source (GrlRegistry *registry,
  * available #GrlSource<!-- -->s. The content of the list should not be
  * modified or freed. Use g_list_free() when done using the list.
  *
- * Since: 0.1.7
+ * Since: 0.2.0
  */
 GList *
 grl_registry_get_sources (GrlRegistry *registry,
@@ -1072,7 +1076,7 @@ grl_registry_get_sources (GrlRegistry *registry,
  * available #GrlSource<!-- -->s. The content of the list should not be
  * modified or freed. Use g_list_free() when done using the list.
  *
- * Since: 0.1.7
+ * Since: 0.2.0
  */
 GList *
 grl_registry_get_sources_by_operations (GrlRegistry *registry,
@@ -1110,6 +1114,8 @@ grl_registry_get_sources_by_operations (GrlRegistry *registry,
  * This function will search and retrieve a plugin given its identifier.
  *
  * Returns: (transfer none): The plugin found
+ *
+ * Since: 0.2.0
  **/
 GrlPlugin *
 grl_registry_lookup_plugin (GrlRegistry *registry,
@@ -1135,6 +1141,8 @@ grl_registry_lookup_plugin (GrlRegistry *registry,
  * Returns: (element-type Grl.Plugin) (transfer container): a #GList of
  * available #GrlPlugin<!-- -->s. The content of the list should not be modified
  * or freed. Use g_list_free() when done using the list.
+ *
+ * Since: 0.2.0
  **/
 GList *
 grl_registry_get_plugins (GrlRegistry *registry,
@@ -1173,7 +1181,7 @@ grl_registry_get_plugins (GrlRegistry *registry,
  *
  * Returns: %TRUE% on success.
  *
- * Since: 0.1.7
+ * Since: 0.2.0
  */
 gboolean
 grl_registry_unload_plugin (GrlRegistry *registry,
@@ -1234,7 +1242,7 @@ grl_registry_unload_plugin (GrlRegistry *registry,
  *
  * Returns: The #GrlKeyID registered.
  *
- * Since: 0.1.7
+ * Since: 0.2.0
  */
 GrlKeyID
 grl_registry_register_metadata_key (GrlRegistry *registry,
@@ -1312,7 +1320,7 @@ grl_registry_register_metadata_key_full (GrlRegistry *registry,
  * Relations between keys allow the framework to provide all the data that is
  * somehow related when any of the related keys are requested.
  *
- * Since: 0.1.10
+ * Since: 0.2.0
  */
 void
 grl_registry_register_metadata_key_relation (GrlRegistry *registry,
@@ -1358,7 +1366,7 @@ grl_registry_register_metadata_key_relation (GrlRegistry *registry,
  *
  * Returns: The metadata key, or GRL_METADATA_KEY_INVALID if not found
  *
- * Since: 0.1.6
+ * Since: 0.2.0
  */
 GrlKeyID
 grl_registry_lookup_metadata_key (GrlRegistry *registry,
@@ -1378,6 +1386,8 @@ grl_registry_lookup_metadata_key (GrlRegistry *registry,
  * Returns @key name.
  *
  * Returns: metadata key name, or @NULL if not found
+ *
+ * Since: 0.2.0
  */
 const gchar *
 grl_registry_lookup_metadata_key_name (GrlRegistry *registry,
@@ -1396,6 +1406,8 @@ grl_registry_lookup_metadata_key_name (GrlRegistry *registry,
  * Returns @key description.
  *
  * Returns: metadata key description, or @NULL if not found
+ *
+ * Since: 0.2.0
  */
 const gchar *
 grl_registry_lookup_metadata_key_desc (GrlRegistry *registry,
@@ -1429,6 +1441,8 @@ grl_registry_lookup_metadata_key_desc (GrlRegistry *registry,
  * Returns @key expected value type.
  *
  * Returns: metadata key type, or @G_TYPE_INVALID if not found
+ *
+ * Since: 0.2.0
  */
 GType
 grl_registry_lookup_metadata_key_type (GrlRegistry *registry,
@@ -1465,6 +1479,8 @@ grl_registry_lookup_metadata_key_type (GrlRegistry *registry,
  * integer values).
  *
  * Returns: %TRUE if complies
+ *
+ * Since: 0.2.0
  **/
 gboolean
 grl_registry_metadata_key_validate (GrlRegistry *registry,
@@ -1504,7 +1520,7 @@ grl_registry_metadata_key_validate (GrlRegistry *registry,
  * Returns: (element-type GrlKeyID) (transfer none): a #GList of
  * related keys, or @NULL if key is invalid.
  *
- * Since: 0.1.10
+ * Since: 0.2.0
  **/
 const GList *
 grl_registry_lookup_metadata_key_relation (GrlRegistry *registry,
@@ -1525,7 +1541,7 @@ grl_registry_lookup_metadata_key_relation (GrlRegistry *registry,
  * #GrlKeyID<!-- -->s. The content of the list should not be modified or freed.
  * Use g_list_free() when done using the list.
  *
- * Since: 0.1.6
+ * Since: 0.2.0
  **/
 GList *
 grl_registry_get_metadata_keys (GrlRegistry *registry)
@@ -1541,7 +1557,7 @@ grl_registry_get_metadata_keys (GrlRegistry *registry)
  *
  * Add a configuration for a plugin/source.
  *
- * Since: 0.1.7
+ * Since: 0.2.0
  */
 gboolean
 grl_registry_add_config (GrlRegistry *registry,
@@ -1591,7 +1607,7 @@ grl_registry_add_config (GrlRegistry *registry,
  *
  * Returns: %TRUE on success
  *
- * Since: 0.1.7
+ * Since: 0.2.0
  **/
 gboolean
 grl_registry_add_config_from_file (GrlRegistry *registry,
diff --git a/src/grl-source.c b/src/grl-source.c
index beceba5..8fb7857 100644
--- a/src/grl-source.c
+++ b/src/grl-source.c
@@ -268,6 +268,8 @@ grl_source_class_init (GrlSourceClass *source_class)
    * GrlSource:source-id:
    *
    * The identifier of the source.
+   *
+   * Since: 0.2.0
    */
   g_object_class_install_property (gobject_class,
                                    PROP_ID,
@@ -282,6 +284,8 @@ grl_source_class_init (GrlSourceClass *source_class)
    * GrlSource:source-name:
    *
    * The name of the source.
+   *
+   * Since: 0.2.0
    */
   g_object_class_install_property (gobject_class,
                                    PROP_NAME,
@@ -296,6 +300,8 @@ grl_source_class_init (GrlSourceClass *source_class)
    * GrlSource:source-desc:
    *
    * A description of the source
+   *
+   * Since: 0.2.0
    */
   g_object_class_install_property (gobject_class,
                                    PROP_DESC,
@@ -310,6 +316,8 @@ grl_source_class_init (GrlSourceClass *source_class)
    * GrlSource:plugin:
    *
    * Plugin the source belongs to
+   *
+   * Since: 0.2.0
    */
   g_object_class_install_property (gobject_class,
                                    PROP_PLUGIN,
@@ -324,6 +332,8 @@ grl_source_class_init (GrlSourceClass *source_class)
    * GrlSource:rank:
    *
    * Source rank
+   *
+   * Since: 0.2.0
    */
   g_object_class_install_property (gobject_class,
                                    PROP_RANK,
@@ -341,6 +351,8 @@ grl_source_class_init (GrlSourceClass *source_class)
    *
    * Transparently split queries with count requests
    * bigger than a certain threshold into smaller queries.
+   *
+   * Since: 0.2.0
    */
   g_object_class_install_property (gobject_class,
                                    PROP_AUTO_SPLIT_THRESHOLD,
@@ -374,6 +386,8 @@ grl_source_class_init (GrlSourceClass *source_class)
    * For the cases where the source can only signal that a change happened, but
    * not where, it would use a list with the the root box (@NULL id) and set
    * location_unknown as @TRUE.
+   *
+   * Since: 0.2.0
    */
   registry_signals[SIG_CONTENT_CHANGED] =
     g_signal_new("content-changed",
@@ -2698,6 +2712,8 @@ check_options (GrlSource *source,
  * source can fetch and store.
  *
  * Returns: (element-type GrlKeyID) (transfer none): a #GList with the keys
+ *
+ * Since: 0.2.0
  */
 const GList *
 grl_source_supported_keys (GrlSource *source)
@@ -2720,6 +2736,8 @@ grl_source_supported_keys (GrlSource *source)
  * to fetch them.
  *
  * Returns: (element-type GrlKeyID) (transfer none): a #GList with the keys
+ *
+ * Since: 0.2.0
  */
 const GList *
 grl_source_slow_keys (GrlSource *source)
@@ -2743,6 +2761,8 @@ grl_source_slow_keys (GrlSource *source)
  *
  * Returns: (element-type GrlKeyID) (transfer none):
  * a #GList with the keys
+ *
+ * Since: 0.2.0
  */
 const GList *
 grl_source_writable_keys (GrlSource *source)
@@ -2761,6 +2781,8 @@ grl_source_writable_keys (GrlSource *source)
  * @source: a source
  *
  * Returns: the ID of the @source
+ *
+ * Since: 0.2.0
  */
 const gchar *
 grl_source_get_id (GrlSource *source)
@@ -2775,6 +2797,8 @@ grl_source_get_id (GrlSource *source)
  * @source: a source
  *
  * Returns: the name of the @source
+ *
+ * Since: 0.2.0
  */
 const gchar *
 grl_source_get_name (GrlSource *source)
@@ -2789,6 +2813,8 @@ grl_source_get_name (GrlSource *source)
  * @source: a source
  *
  * Returns: the description of the @source
+ *
+ * Since: 0.2.0
  */
 const gchar *
 grl_source_get_description (GrlSource *source)
@@ -2803,6 +2829,8 @@ grl_source_get_description (GrlSource *source)
  * @source: a source
  *
  * Returns: (transfer none): the plugin this source belongs to
+ *
+ * Since: 0.2.0
  **/
 GrlPlugin *
 grl_source_get_plugin (GrlSource *source)
@@ -2819,6 +2847,8 @@ grl_source_get_plugin (GrlSource *source)
  * Gets the source rank
  *
  * Returns: rank value
+ *
+ * Since: 0.2.0
  **/
 gint
 grl_source_get_rank (GrlSource *source)
@@ -2836,6 +2866,8 @@ grl_source_get_rank (GrlSource *source)
  *
  * Returns: (type uint): a bitwise mangle with the supported operations by
  * the source
+ *
+ * Since: 0.2.0
  */
 GrlSupportedOps
 grl_source_supported_operations (GrlSource *source)
@@ -2891,6 +2923,8 @@ grl_source_supported_operations (GrlSource *source)
  * See #grl_source_set_auto_split_threshold()
  *
  * Returns: the assigned threshold, or 0 if there is no threshold
+ *
+ * Since: 0.2.0
  */
 guint
 grl_source_get_auto_split_threshold (GrlSource *source)
@@ -2920,6 +2954,7 @@ grl_source_get_auto_split_threshold (GrlSource *source)
  *  </para>
  * </note>
  *
+ * Since: 0.2.0
  */
 void
 grl_source_set_auto_split_threshold (GrlSource *source,
@@ -2945,7 +2980,9 @@ grl_source_set_auto_split_threshold (GrlSource *source,
  *
  * This method is asynchronous.
  *
- * Returns: the operation identifier
+ * Returns: the operation identifie
+ *
+ * Since: 0.2.0
  */
 guint
 grl_source_resolve (GrlSource *source,
@@ -3081,6 +3118,8 @@ grl_source_resolve (GrlSource *source,
  * This method is synchronous.
  *
  * Returns: (transfer full): a filled #GrlMedia
+ *
+ * Since: 0.2.0
  */
 GrlMedia *
 grl_source_resolve_sync (GrlSource *source,
@@ -3134,6 +3173,8 @@ grl_source_resolve_sync (GrlSource *source,
  *
  * Returns: @TRUE if there's a possibility that @source resolves @key_id for
  * @media, @FALSE otherwise.
+ *
+ * Since: 0.2.0
  */
 gboolean
 grl_source_may_resolve (GrlSource *source,
@@ -3197,6 +3238,8 @@ grl_source_may_resolve (GrlSource *source,
  * Returns: %TRUE if it can, %FALSE otherwise.
  *
  * This method is synchronous.
+ *
+ * Since: 0.2.0
  */
 gboolean
 grl_source_test_media_from_uri (GrlSource *source,
@@ -3232,6 +3275,8 @@ grl_source_test_media_from_uri (GrlSource *source,
  * This method is asynchronous.
  *
  * Returns: the operation identifier
+ *
+ * Since: 0.2.0
  */
 guint
 grl_source_get_media_from_uri (GrlSource *source,
@@ -3329,6 +3374,8 @@ grl_source_get_media_from_uri (GrlSource *source,
  * This method is synchronous.
  *
  * Returns: (transfer full): a filled #GrlMedia
+ *
+ * Since: 0.2.0
  */
 GrlMedia *
 grl_source_get_media_from_uri_sync (GrlSource *source,
@@ -3380,6 +3427,8 @@ grl_source_get_media_from_uri_sync (GrlSource *source,
  * This method is asynchronous.
  *
  * Returns: the operation identifier
+ *
+ * Since: 0.2.0
  */
 guint
 grl_source_browse (GrlSource *source,
@@ -3486,6 +3535,8 @@ grl_source_browse (GrlSource *source,
  * Returns: (element-type Grl.Media) (transfer full): a #GList with #GrlMedia
  * elements. After use g_object_unref() every element and g_list_free() the
  * list.
+ *
+ * Since: 0.2.0
  */
 GList *
 grl_source_browse_sync (GrlSource *source,
@@ -3542,6 +3593,8 @@ grl_source_browse_sync (GrlSource *source,
  * This method is asynchronous.
  *
  * Returns: the operation identifier
+ *
+ * Since: 0.2.0
  */
 guint
 grl_source_search (GrlSource *source,
@@ -3643,6 +3696,8 @@ grl_source_search (GrlSource *source,
  * Returns: (element-type Grl.Media) (transfer full): a #GList with #GrlMedia
  * elements. After use g_object_unref() every element and g_list_free() the
  * list.
+ *
+ * Since: 0.2.0
  */
 GList *
 grl_source_search_sync (GrlSource *source,
@@ -3698,6 +3753,8 @@ grl_source_search_sync (GrlSource *source,
  * This method is asynchronous.
  *
  * Returns: the operation identifier
+ *
+ * Since: 0.2.0
  */
 guint
 grl_source_query (GrlSource *source,
@@ -3795,6 +3852,8 @@ grl_source_query (GrlSource *source,
  * Returns: (element-type Grl.Media) (transfer full): a #GList with #GrlMedia
  * elements. After use g_object_unref() every element and g_list_free() the
  * list.
+ *
+ * Since: 0.2.0
  */
 GList *
 grl_source_query_sync (GrlSource *source,
@@ -3841,6 +3900,8 @@ grl_source_query_sync (GrlSource *source,
  * Remove a @media from the @source repository.
  *
  * This method is asynchronous.
+ *
+ * Since: 0.2.0
  */
 void
 grl_source_remove (GrlSource *source,
@@ -3897,7 +3958,7 @@ grl_source_remove (GrlSource *source,
  *
  * This method is synchronous.
  *
- * Since: 0.1.6
+ * Since: 0.2.0
  */
 void
 grl_source_remove_sync (GrlSource *source,
@@ -3938,6 +3999,8 @@ grl_source_remove_sync (GrlSource *source,
  * Store the @media into the @parent container
  *
  * This method is asynchronous.
+ *
+ * Since: 0.2.0
  */
 void
 grl_source_store (GrlSource *source,
@@ -3987,6 +4050,8 @@ grl_source_store (GrlSource *source,
  * Store the @media into the @parent container.
  *
  * This method is synchronous.
+ *
+ * Since: 0.2.0
  */
 void
 grl_source_store_sync (GrlSource *source,
@@ -4035,6 +4100,8 @@ grl_source_store_sync (GrlSource *source,
  * shall return this new values for the selected keys.
  *
  * This function is asynchronous and uses the Glib's main loop.
+ *
+ * Since: 0.2.0
  */
 void
 grl_source_store_metadata (GrlSource *source,
@@ -4072,6 +4139,8 @@ grl_source_store_metadata (GrlSource *source,
  *
  * Returns: (element-type GrlKeyID) (transfer container):
  * a #GList of keys that could not be updated, or @NULL
+ *
+ * Since: 0.2.0
  */
 GList *
 grl_source_store_metadata_sync (GrlSource *source,
@@ -4119,6 +4188,8 @@ grl_source_store_metadata_sync (GrlSource *source,
  * of changes in the content.
  *
  * Returns: @TRUE if initialization has succeed.
+ *
+ * Since: 0.2.0
  */
 gboolean
 grl_source_notify_change_start (GrlSource *source,
@@ -4143,6 +4214,8 @@ grl_source_notify_change_start (GrlSource *source,
  * the content.
  *
  * Returns: @TRUE if stop has succeed.
+ *
+ * Since: 0.2.0
  */
 gboolean
 grl_source_notify_change_stop (GrlSource *source,
@@ -4179,6 +4252,8 @@ grl_source_notify_change_stop (GrlSource *source,
  *    This function is intended to be used only by plugins.
  *  </para>
  * </note>
+ *
+ * Since: 0.2.0
  */
 void grl_source_notify_change_list (GrlSource *source,
                                     GPtrArray *changed_medias,
@@ -4226,6 +4301,8 @@ void grl_source_notify_change_list (GrlSource *source,
  *    This function is intended to be used only by plugins.
  *  </para>
  * </note>
+ *
+ * Since: 0.2.0
  */
 void grl_source_notify_change (GrlSource *source,
                                GrlMedia *media,
@@ -4259,6 +4336,8 @@ void grl_source_notify_change (GrlSource *source,
  * Get the capabilities of @source for @operation.
  *
  * Returns: (transfer none): The capabilities
+ *
+ * Since: 0.2.0
  */
 GrlCaps *
 grl_source_get_caps (GrlSource *source,
diff --git a/src/grl-util.c b/src/grl-util.c
index c67c91d..a05e1aa 100644
--- a/src/grl-util.c
+++ b/src/grl-util.c
@@ -127,6 +127,7 @@ grl_list_from_va (gpointer p, ...)
  * Returns: a newly-allocated #GDateTime set to the time corresponding to
  * @date, or %NULL if @date could not be parsed properly.
  *
+ * Since: 0.2.0
  */
 GDateTime *
 grl_date_time_from_iso8601 (const gchar *date)
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]