[grilo] doc: Add release where functions were introduced
- From: Juan A. Suarez Romero <jasuarez src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [grilo] doc: Add release where functions were introduced
- Date: Thu, 13 Jan 2011 18:11:26 +0000 (UTC)
commit 7fd77c3f9b6b840cfa03343ba1386a30213228ae
Author: Juan A. Suarez Romero <jasuarez igalia com>
Date: Thu Jan 13 18:24:02 2011 +0100
doc: Add release where functions were introduced
Add 'since' tag documentation, telling in which release a function was
introduced with the current signature.
Signed-off-by: Juan A. Suarez Romero <jasuarez igalia com>
src/data/grl-config.c | 20 ++++++++++
src/data/grl-data.c | 32 ++++++++++++++++
src/data/grl-media-audio.c | 22 +++++++++++
src/data/grl-media-box.c | 6 +++
src/data/grl-media-image.c | 12 ++++++
src/data/grl-media-video.c | 16 ++++++++
src/data/grl-media.c | 86 ++++++++++++++++++++++++++++++++++++++++++++
src/grilo.c | 4 ++
src/grl-log.c | 4 ++
src/grl-media-plugin.c | 22 +++++++++++
src/grl-media-source.c | 38 +++++++++++++++++++
src/grl-metadata-key.c | 4 ++
src/grl-metadata-source.c | 30 +++++++++++++++
src/grl-multiple.c | 7 ++++
src/grl-plugin-registry.c | 32 ++++++++++++++++
src/grl-util.c | 4 ++
16 files changed, 339 insertions(+), 0 deletions(-)
---
diff --git a/src/data/grl-config.c b/src/data/grl-config.c
index 8bc780d..e9c0f36 100644
--- a/src/data/grl-config.c
+++ b/src/data/grl-config.c
@@ -104,6 +104,8 @@ grl_config_finalize (GObject *object)
* Returns: (transfer none): a newly-allocated data config. The data
* config associated with the plugin should not be freed until the plugin
* has been unloaded.
+ *
+ * Since: 0.1.4
*/
GrlConfig *
grl_config_new (const gchar *plugin, const gchar *source)
@@ -209,6 +211,8 @@ grl_config_get_float (GrlConfig *config, const gchar *param)
* @plugin: the plugin id
*
* Set the plugin key in the configuration
+ *
+ * Since: 0.1.4
*/
void
grl_config_set_plugin (GrlConfig *config, const gchar *plugin)
@@ -224,6 +228,8 @@ grl_config_set_plugin (GrlConfig *config, const gchar *plugin)
* @source: the source id
*
* Set the plugin key in the configuration
+ *
+ * Since: 0.1.4
*/
void
grl_config_set_source (GrlConfig *config, const gchar *source)
@@ -239,6 +245,8 @@ grl_config_set_source (GrlConfig *config, const gchar *source)
* @key: the API key
*
* Set the webservice API key in the configuration
+ *
+ * Since: 0.1.4
*/
void
grl_config_set_api_key (GrlConfig *config, const gchar *key)
@@ -254,6 +262,8 @@ grl_config_set_api_key (GrlConfig *config, const gchar *key)
* @token: the API token
*
* Set the webservice API token in the configuration
+ *
+ * Since: 0.1.4
*/
void
grl_config_set_api_token (GrlConfig *config, const gchar *token)
@@ -269,6 +279,8 @@ grl_config_set_api_token (GrlConfig *config, const gchar *token)
* @secret: the webservice passphrase
*
* Set the webservice passphrase in the configuration
+ *
+ * Since: 0.1.4
*/
void
grl_config_set_api_secret (GrlConfig *config, const gchar *secret)
@@ -283,6 +295,8 @@ grl_config_set_api_secret (GrlConfig *config, const gchar *secret)
* @config: the config instance
*
* Returns: the plugin id
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_config_get_plugin (GrlConfig *config)
@@ -296,6 +310,8 @@ grl_config_get_plugin (GrlConfig *config)
* @config: the config instance
*
* Returns: the webservice API key
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_config_get_api_key (GrlConfig *config)
@@ -309,6 +325,8 @@ grl_config_get_api_key (GrlConfig *config)
* @config: the config instance
*
* Returns: the webservice API token
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_config_get_api_token (GrlConfig *config)
@@ -322,6 +340,8 @@ grl_config_get_api_token (GrlConfig *config)
* @config: the config instance
*
* Returns: the webservice API passphrase
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_config_get_api_secret (GrlConfig *config)
diff --git a/src/data/grl-data.c b/src/data/grl-data.c
index 81a30f9..4a713d2 100644
--- a/src/data/grl-data.c
+++ b/src/data/grl-data.c
@@ -152,6 +152,8 @@ grl_data_get_property (GObject *object,
* Creates a new data object.
*
* Returns: a new data object.
+ *
+ * Since: 0.1.4
**/
GrlData *
grl_data_new (void)
@@ -169,6 +171,8 @@ grl_data_new (void)
* will be returned.
*
* Returns: (transfer none): a #GValue. This value should not be modified nor freed by user.
+ *
+ * Since: 0.1.4
**/
const GValue *
grl_data_get (GrlData *data, GrlKeyID key)
@@ -191,6 +195,8 @@ grl_data_get (GrlData *data, GrlKeyID key)
* Also, checks that value is compliant with the key specification, modifying it
* accordingly. For instance, if the key requires a number between 0 and 10, but
* value is outside this range, it will be adapted accordingly.
+ *
+ * Since: 0.1.4
**/
void
grl_data_set (GrlData *data, GrlKeyID key, const GValue *value)
@@ -231,6 +237,8 @@ grl_data_set (GrlData *data, GrlKeyID key, const GValue *value)
*
* Sets the value associated with the key. If key already has a value and
* #overwrite is TRUE, old value is freed and the new one is set.
+ *
+ * Since: 0.1.4
**/
void
grl_data_set_string (GrlData *data,
@@ -257,6 +265,8 @@ grl_data_set_string (GrlData *data,
* not string, or key is not in data, then NULL is returned.
*
* Returns: string associated with key, or NULL in other case. Caller should not change nor free the value.
+ *
+ * Since: 0.1.4
**/
const gchar *
grl_data_get_string (GrlData *data, GrlKeyID key)
@@ -278,6 +288,8 @@ grl_data_get_string (GrlData *data, GrlKeyID key)
*
* Sets the value associated with the key. If key already has a value and
* #overwrite is TRUE, old value is replaced by the new one.
+ *
+ * Since: 0.1.4
**/
void
grl_data_set_int (GrlData *data, GrlKeyID key, gint intvalue)
@@ -297,6 +309,8 @@ grl_data_set_int (GrlData *data, GrlKeyID key, gint intvalue)
* not a gint, or key is not in data, then 0 is returned.
*
* Returns: int value associated with key, or 0 in other case.
+ *
+ * Since: 0.1.4
**/
gint
grl_data_get_int (GrlData *data, GrlKeyID key)
@@ -318,6 +332,8 @@ grl_data_get_int (GrlData *data, GrlKeyID key)
*
* Sets the value associated with the key. If key already has a value and
* #overwrite is TRUE, old value is replaced by the new one.
+ *
+ * Since: 0.1.5
**/
void
grl_data_set_float (GrlData *data, GrlKeyID key, float floatvalue)
@@ -337,6 +353,8 @@ grl_data_set_float (GrlData *data, GrlKeyID key, float floatvalue)
* not a gfloat, or key is not in data, then 0 is returned.
*
* Returns: float value associated with key, or 0 in other case.
+ *
+ * Since: 0.1.5
**/
gfloat
grl_data_get_float (GrlData *data, GrlKeyID key)
@@ -357,6 +375,8 @@ grl_data_get_float (GrlData *data, GrlKeyID key)
*
* Adds a new key to data, with no value. If key already exists, it does
* nothing.
+ *
+ * Since: 0.1.4
**/
void
grl_data_add (GrlData *data, GrlKeyID key)
@@ -373,6 +393,8 @@ grl_data_add (GrlData *data, GrlKeyID key)
*
* Removes key from data, freeing its value. If key is not in data, then
* it does nothing.
+ *
+ * Since: 0.1.4
**/
void
grl_data_remove (GrlData *data, GrlKeyID key)
@@ -390,6 +412,8 @@ grl_data_remove (GrlData *data, GrlKeyID key)
* Checks if key is in data.
*
* Returns: TRUE if key is in data, FALSE in other case.
+ *
+ * Since: 0.1.4
**/
gboolean
grl_data_has_key (GrlData *data, GrlKeyID key)
@@ -408,6 +432,8 @@ grl_data_has_key (GrlData *data, GrlKeyID key)
* Returns: (transfer container) (element-type GObject.ParamSpec): an array with
* the keys. The content of the list should not be modified or freed. Use g_list_free()
* when done using the list.
+ *
+ * Since: 0.1.4
**/
GList *
grl_data_get_keys (GrlData *data)
@@ -429,6 +455,8 @@ grl_data_get_keys (GrlData *data)
* Checks if the key has a value.
*
* Returns: TRUE if key has a value.
+ *
+ * Since: 0.1.4
**/
gboolean
grl_data_key_is_known (GrlData *data, GrlKeyID key)
@@ -460,6 +488,8 @@ grl_data_key_is_known (GrlData *data, GrlKeyID key)
*
* Set it to TRUE so old values are overwritten, or FALSE in other case (default
* is FALSE).
+ *
+ * Since: 0.1.4
**/
void
grl_data_set_overwrite (GrlData *data, gboolean overwrite)
@@ -479,6 +509,8 @@ grl_data_set_overwrite (GrlData *data, gboolean overwrite)
* Checks if old values are replaced when calling #grl_data_set.
*
* Returns: TRUE if values will be overwritten.
+ *
+ * Since: 0.1.4
**/
gboolean
grl_data_get_overwrite (GrlData *data)
diff --git a/src/data/grl-media-audio.c b/src/data/grl-media-audio.c
index fd5618a..8c72063 100644
--- a/src/data/grl-media-audio.c
+++ b/src/data/grl-media-audio.c
@@ -72,6 +72,8 @@ grl_media_audio_finalize (GObject *object)
* Creates a new data audio object.
*
* Returns: a newly-allocated data audio.
+ *
+ * Since: 0.1.4
**/
GrlMedia *
grl_media_audio_new (void)
@@ -86,6 +88,8 @@ grl_media_audio_new (void)
* @artist: the audio's artist
*
* Set the artist of the audio
+ *
+ * Since: 0.1.4
*/
void
grl_media_audio_set_artist (GrlMediaAudio *data, const gchar *artist)
@@ -100,6 +104,8 @@ grl_media_audio_set_artist (GrlMediaAudio *data, const gchar *artist)
* @album: the audio's album
*
* Set the album of the audio
+ *
+ * Since: 0.1.4
*/
void
grl_media_audio_set_album (GrlMediaAudio *data, const gchar *album)
@@ -114,6 +120,8 @@ grl_media_audio_set_album (GrlMediaAudio *data, const gchar *album)
* @genre: the audio's genre
*
* Set the genre of the audio
+ *
+ * Since: 0.1.4
*/
void
grl_media_audio_set_genre (GrlMediaAudio *data, const gchar *genre)
@@ -128,6 +136,8 @@ grl_media_audio_set_genre (GrlMediaAudio *data, const gchar *genre)
* @lyrics: the audio's lyrics
*
* Set the lyrics of the audio
+ *
+ * Since: 0.1.4
*/
void
grl_media_audio_set_lyrics (GrlMediaAudio *data, const gchar *lyrics)
@@ -142,6 +152,8 @@ grl_media_audio_set_lyrics (GrlMediaAudio *data, const gchar *lyrics)
* @bitrate: the audio's bitrate
*
* Set the bitrate of the audio
+ *
+ * Since: 0.1.4
*/
void
grl_media_audio_set_bitrate (GrlMediaAudio *data, gint bitrate)
@@ -155,6 +167,8 @@ grl_media_audio_set_bitrate (GrlMediaAudio *data, gint bitrate)
* @data: the media instance
*
* Returns: the artist of the audio
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_media_audio_get_artist (GrlMediaAudio *data)
@@ -167,6 +181,8 @@ grl_media_audio_get_artist (GrlMediaAudio *data)
* @data: the media instance
*
* Returns: the album of the audio
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_media_audio_get_album (GrlMediaAudio *data)
@@ -179,6 +195,8 @@ grl_media_audio_get_album (GrlMediaAudio *data)
* @data: the media instance
*
* Returns: the genre of the audio
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_media_audio_get_genre (GrlMediaAudio *data)
@@ -191,6 +209,8 @@ grl_media_audio_get_genre (GrlMediaAudio *data)
* @data: the media instance
*
* Returns: the lyrics of the audio
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_media_audio_get_lyrics (GrlMediaAudio *data)
@@ -203,6 +223,8 @@ grl_media_audio_get_lyrics (GrlMediaAudio *data)
* @data: the media instance
*
* Returns: the bitrate of the audio
+ *
+ * Since: 0.1.4
*/
gint
grl_media_audio_get_bitrate (GrlMediaAudio *data)
diff --git a/src/data/grl-media-box.c b/src/data/grl-media-box.c
index b968219..bd6cba2 100644
--- a/src/data/grl-media-box.c
+++ b/src/data/grl-media-box.c
@@ -89,6 +89,8 @@ grl_media_box_finalize (GObject *object)
* Creates a new data box object.
*
* Returns: a newly-allocated data box.
+ *
+ * Since: 0.1.4
*/
GrlMedia *
grl_media_box_new (void)
@@ -104,6 +106,8 @@ grl_media_box_new (void)
*
* Sets the number of children of this box. Use
* #GRL_METADATA_KEY_CHILDCOUNT_UNKNOWN if it is unknown.
+ *
+ * Since: 0.1.4
*/
void
grl_media_box_set_childcount (GrlMediaBox *box,
@@ -130,6 +134,8 @@ grl_media_box_set_childcount (GrlMediaBox *box,
*
* Returns: number of children, or #GRL_METADATA_KEY_CHILDCOUNT_UNKNOWN if
* unknown.
+ *
+ * Since: 0.1.4
*/
gint
grl_media_box_get_childcount (GrlMediaBox *box)
diff --git a/src/data/grl-media-image.c b/src/data/grl-media-image.c
index 623e7f7..fe614a3 100644
--- a/src/data/grl-media-image.c
+++ b/src/data/grl-media-image.c
@@ -72,6 +72,8 @@ grl_media_image_finalize (GObject *object)
* Creates a new data image object.
*
* Returns: a newly-allocated data image.
+ *
+ * Since: 0.1.4
**/
GrlMedia *
grl_media_image_new (void)
@@ -87,6 +89,8 @@ grl_media_image_new (void)
* @height: the image's height
*
* Set the size of the image
+ *
+ * Since: 0.1.4
*/
void
grl_media_image_set_size (GrlMediaImage *image,
@@ -103,6 +107,8 @@ grl_media_image_set_size (GrlMediaImage *image,
* @width: the image's width
*
* Set the width of the image
+ *
+ * Since: 0.1.4
*/
void
grl_media_image_set_width (GrlMediaImage *data, gint width)
@@ -118,6 +124,8 @@ grl_media_image_set_width (GrlMediaImage *data, gint width)
* @height: the image's height
*
* Set the height of the image
+ *
+ * Since: 0.1.4
*/
void
grl_media_image_set_height (GrlMediaImage *data, gint height)
@@ -132,6 +140,8 @@ grl_media_image_set_height (GrlMediaImage *data, gint height)
* @data: The image instance
*
* Returns: the width of the image
+ *
+ * Since: 0.1.4
*/
gint
grl_media_image_get_width (GrlMediaImage *data)
@@ -144,6 +154,8 @@ grl_media_image_get_width (GrlMediaImage *data)
* @data: the image instance
*
* Returns: the height of the image
+ *
+ * Since: 0.1.4
*/
gint
grl_media_image_get_height (GrlMediaImage *data)
diff --git a/src/data/grl-media-video.c b/src/data/grl-media-video.c
index 495cd42..5ec20a1 100644
--- a/src/data/grl-media-video.c
+++ b/src/data/grl-media-video.c
@@ -72,6 +72,8 @@ grl_media_video_finalize (GObject *object)
* Creates a new data video object.
*
* Returns: a newly-allocated data video.
+ *
+ * Since: 0.1.4
*/
GrlMedia *
grl_media_video_new (void)
@@ -87,6 +89,8 @@ grl_media_video_new (void)
* @height: the video's height
*
* Set the width and the height of the video
+ *
+ * Since: 0.1.4
*/
void
grl_media_video_set_size (GrlMediaVideo *video,
@@ -103,6 +107,8 @@ grl_media_video_set_size (GrlMediaVideo *video,
* @width: the video's width
*
* Set the width of the video
+ *
+ * Since: 0.1.4
*/
void
grl_media_video_set_width (GrlMediaVideo *data, gint width)
@@ -118,6 +124,8 @@ grl_media_video_set_width (GrlMediaVideo *data, gint width)
* @height: the video's height
*
* Set the height of the video
+ *
+ * Since: 0.1.4
*/
void
grl_media_video_set_height (GrlMediaVideo *data, gint height)
@@ -133,6 +141,8 @@ grl_media_video_set_height (GrlMediaVideo *data, gint height)
* @framerate: the video's framerate
*
* Set the framerate of the video
+ *
+ * Since: 0.1.4
*/
void
grl_media_video_set_framerate (GrlMediaVideo *data, gfloat framerate)
@@ -147,6 +157,8 @@ grl_media_video_set_framerate (GrlMediaVideo *data, gfloat framerate)
* @data: the media instance
*
* Returns: the width of the video
+ *
+ * Since: 0.1.4
*/
gint
grl_media_video_get_width (GrlMediaVideo *data)
@@ -159,6 +171,8 @@ grl_media_video_get_width (GrlMediaVideo *data)
* @data: the media instance
*
* Returns: the height of the video
+ *
+ * Since: 0.1.4
*/
gint
grl_media_video_get_height (GrlMediaVideo *data)
@@ -171,6 +185,8 @@ grl_media_video_get_height (GrlMediaVideo *data)
* @data: the media instance
*
* Returns: the framerate of the video
+ *
+ * Since: 0.1.4
*/
gfloat
grl_media_video_get_framerate (GrlMediaVideo *data)
diff --git a/src/data/grl-media.c b/src/data/grl-media.c
index d4ff748..215f85c 100644
--- a/src/data/grl-media.c
+++ b/src/data/grl-media.c
@@ -82,6 +82,8 @@ grl_media_finalize (GObject *object)
* Creates a new data media object.
*
* Returns: a newly-allocated data media.
+ *
+ * Since: 0.1.4
**/
GrlMedia *
grl_media_new (void)
@@ -97,6 +99,8 @@ grl_media_new (void)
* @max: maximum rating value
*
* This method receives a rating and its scale and normalizes it
+ *
+ * Since: 0.1.5
*/
void
grl_media_set_rating (GrlMedia *media, gfloat rating, gfloat max)
@@ -116,6 +120,8 @@ grl_media_set_rating (GrlMedia *media, gfloat rating, gfloat max)
* See grl_media_serialize_extended() to get more serialization approaches.
*
* Returns: serialized media
+ *
+ * Since: 0.1.6
**/
gchar *
grl_media_serialize (GrlMedia *media)
@@ -138,6 +144,8 @@ grl_media_serialize (GrlMedia *media)
* always considered).
*
* Returns: serialized media
+ *
+ * Since: 0.1.6
**/
gchar *
grl_media_serialize_extended (GrlMedia *media,
@@ -253,6 +261,8 @@ grl_media_serialize_extended (GrlMedia *media,
* Unserializes a GrlMedia.
*
* Returns: (transfer full): the GrlMedia from the serial
+ *
+ * Since: 0.1.6
**/
GrlMedia *
grl_media_unserialize (const gchar *serial)
@@ -369,6 +379,8 @@ grl_media_unserialize (const gchar *serial)
* @id: the identifier of the media
*
* Set the media identifier
+ *
+ * Since: 0.1.4
*/
void
grl_media_set_id (GrlMedia *data, const gchar *id)
@@ -384,6 +396,8 @@ grl_media_set_id (GrlMedia *data, const gchar *id)
* @url: the media's URL
*
* Set the media's URL
+ *
+ * Since: 0.1.4
*/
void
grl_media_set_url (GrlMedia *data, const gchar *url)
@@ -399,6 +413,8 @@ grl_media_set_url (GrlMedia *data, const gchar *url)
* @author: the media's author
*
* Set the media's author
+ *
+ * Since: 0.1.4
*/
void
grl_media_set_author (GrlMedia *data, const gchar *author)
@@ -414,6 +430,8 @@ grl_media_set_author (GrlMedia *data, const gchar *author)
* @title: the title
*
* Set the media's title
+ *
+ * Since: 0.1.4
*/
void
grl_media_set_title (GrlMedia *data, const gchar *title)
@@ -429,6 +447,8 @@ grl_media_set_title (GrlMedia *data, const gchar *title)
* @description: the description
*
* Set the media's description
+ *
+ * Since: 0.1.4
*/
void
grl_media_set_description (GrlMedia *data, const gchar *description)
@@ -444,6 +464,8 @@ grl_media_set_description (GrlMedia *data, const gchar *description)
* @source: the source
*
* Set the media's source
+ *
+ * Since: 0.1.4
*/
void
grl_media_set_source (GrlMedia *data, const gchar *source)
@@ -459,6 +481,8 @@ grl_media_set_source (GrlMedia *data, const gchar *source)
* @thumbnail: the thumbnail URL
*
* Set the media's thumbnail URL
+ *
+ * Since: 0.1.4
*/
void
grl_media_set_thumbnail (GrlMedia *data, const gchar *thumbnail)
@@ -474,6 +498,8 @@ grl_media_set_thumbnail (GrlMedia *data, const gchar *thumbnail)
* @site: the site
*
* Set the media's site
+ *
+ * Since: 0.1.4
*/
void
grl_media_set_site (GrlMedia *data, const gchar *site)
@@ -489,6 +515,8 @@ grl_media_set_site (GrlMedia *data, const gchar *site)
* @duration: the duration
*
* Set the media's duration
+ *
+ * Since: 0.1.4
*/
void
grl_media_set_duration (GrlMedia *data, gint duration)
@@ -519,6 +547,8 @@ grl_media_set_date (GrlMedia *data, const gchar *date)
* @mime: the mime type
*
* Set the media's mime-type
+ *
+ * Since: 0.1.4
*/
void
grl_media_set_mime (GrlMedia *data, const gchar *mime)
@@ -534,6 +564,8 @@ grl_media_set_mime (GrlMedia *data, const gchar *mime)
* @play_count: the play count
*
* Set the media play count
+ *
+ * Since: 0.1.4
*/
void
grl_media_set_play_count (GrlMedia *data, gint play_count)
@@ -549,6 +581,8 @@ grl_media_set_play_count (GrlMedia *data, gint play_count)
* @last_played: date when the media was last played
*
* Set the media last played date
+ *
+ * Since: 0.1.4
*/
void
grl_media_set_last_played (GrlMedia *data, const gchar *last_played)
@@ -564,6 +598,8 @@ grl_media_set_last_played (GrlMedia *data, const gchar *last_played)
* @last_position: second at which the media playback was interrupted
*
* Set the media last played position
+ *
+ * Since: 0.1.4
*/
void
grl_media_set_last_position (GrlMedia *data, gint last_position)
@@ -579,6 +615,8 @@ grl_media_set_last_position (GrlMedia *data, gint last_position)
* @player: location of an external player for this media
*
* Set the location of a player for the media (usually a flash player)
+ *
+ * Since: 0.1.6
*/
void
grl_media_set_external_player (GrlMedia *data, const gchar *player)
@@ -594,6 +632,8 @@ grl_media_set_external_player (GrlMedia *data, const gchar *player)
* @url: external location where this media can be played.
*
* Set an external location where users can play the media
+ *
+ * Since: 0.1.6
*/
void
grl_media_set_external_url (GrlMedia *data, const gchar *url)
@@ -609,6 +649,8 @@ grl_media_set_external_url (GrlMedia *data, const gchar *url)
* @studio: The studio the media is from
*
* Set the media studio
+ *
+ * Since: 0.1.6
*/
void
grl_media_set_studio (GrlMedia *data, const gchar *studio)
@@ -624,6 +666,8 @@ grl_media_set_studio (GrlMedia *data, const gchar *studio)
* @certificate: The rating certificate of the media
*
* Set the media certificate
+ *
+ * Since: 0.1.6
*/
void
grl_media_set_certificate (GrlMedia *data, const gchar *certificate)
@@ -639,6 +683,8 @@ grl_media_set_certificate (GrlMedia *data, const gchar *certificate)
* @license: The license of the media
*
* Set the media license
+ *
+ * Since: 0.1.6
*/
void
grl_media_set_license (GrlMedia *data, const gchar *license)
@@ -653,6 +699,8 @@ grl_media_set_license (GrlMedia *data, const gchar *license)
* @data: the media object
*
* Returns: the media's identifier
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_media_get_id (GrlMedia *data)
@@ -665,6 +713,8 @@ grl_media_get_id (GrlMedia *data)
* @data: the media object
*
* Returns: the media's URL
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_media_get_url (GrlMedia *data)
@@ -677,6 +727,8 @@ grl_media_get_url (GrlMedia *data)
* @data: the media object
*
* Returns: the media's author
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_media_get_author (GrlMedia *data)
@@ -689,6 +741,8 @@ grl_media_get_author (GrlMedia *data)
* @data: the media object
*
* Returns: the media's title
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_media_get_title (GrlMedia *data)
@@ -701,6 +755,8 @@ grl_media_get_title (GrlMedia *data)
* @data: the media object
*
* Returns: the media's description
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_media_get_description (GrlMedia *data)
@@ -713,6 +769,8 @@ grl_media_get_description (GrlMedia *data)
* @data: the media object source
*
* Returns: the media's source
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_media_get_source (GrlMedia *data)
@@ -725,6 +783,8 @@ grl_media_get_source (GrlMedia *data)
* @data: the media object
*
* Returns: the media's thumbnail URL
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_media_get_thumbnail (GrlMedia *data)
@@ -737,6 +797,8 @@ grl_media_get_thumbnail (GrlMedia *data)
* @data: the media object
*
* Returns: the media's site
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_media_get_site (GrlMedia *data)
@@ -749,6 +811,8 @@ grl_media_get_site (GrlMedia *data)
* @data: the media object
*
* Returns: the media's duration
+ *
+ * Since: 0.1.4
*/
gint
grl_media_get_duration (GrlMedia *data)
@@ -761,6 +825,8 @@ grl_media_get_duration (GrlMedia *data)
* @data: the media object
*
* Returns: the media's date (TBD)
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_media_get_date (GrlMedia *data)
@@ -773,6 +839,8 @@ grl_media_get_date (GrlMedia *data)
* @data: the media object
*
* Returns: the media's mime-type
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_media_get_mime (GrlMedia *data)
@@ -785,6 +853,8 @@ grl_media_get_mime (GrlMedia *data)
* @data: the media object
*
* Returns: the media's rating
+ *
+ * Since: 0.1.5
*/
gfloat
grl_media_get_rating (GrlMedia *data)
@@ -797,6 +867,8 @@ grl_media_get_rating (GrlMedia *data)
* @data: the media object
*
* Returns: the media's play count
+ *
+ * Since: 0.1.4
*/
gint
grl_media_get_play_count (GrlMedia *data)
@@ -809,6 +881,8 @@ grl_media_get_play_count (GrlMedia *data)
* @data: the media object
*
* Returns: the media's last_played position (in seconds)
+ *
+ * Since: 0.1.4
*/
gint
grl_media_get_last_position (GrlMedia *data)
@@ -821,6 +895,8 @@ grl_media_get_last_position (GrlMedia *data)
* @data: the media object
*
* Returns: the media's last played time
+ *
+ * Since: 0.1.4
*/
const gchar *
grl_media_get_last_played (GrlMedia *data)
@@ -834,6 +910,8 @@ grl_media_get_last_played (GrlMedia *data)
*
* Returns: URL of an external player
* object for this media
+ *
+ * Since: 0.1.6
*/
const gchar *
grl_media_get_player(GrlMedia *data)
@@ -848,6 +926,8 @@ grl_media_get_player(GrlMedia *data)
*
* Returns: URL of an external location
* where the user play the media.
+ *
+ * Since: 0.1.6
*/
const gchar *
grl_media_get_external_url (GrlMedia *data)
@@ -860,6 +940,8 @@ grl_media_get_external_url (GrlMedia *data)
* @data: the media object
*
* Returns: the studio the media is from
+ *
+ * Since: 0.1.6
*/
const gchar *
grl_media_get_studio(GrlMedia *data)
@@ -872,6 +954,8 @@ grl_media_get_studio(GrlMedia *data)
* @data: the media object
*
* Returns: the media's certificate
+ *
+ * Since: 0.1.6
*/
const gchar *
grl_media_get_certificate (GrlMedia *data)
@@ -884,6 +968,8 @@ grl_media_get_certificate (GrlMedia *data)
* @data: the media object
*
* Returns: the license the media is under
+ *
+ * Since: 0.1.6
*/
const gchar *
grl_media_get_license (GrlMedia *data)
diff --git a/src/grilo.c b/src/grilo.c
index 7bba467..a8e2457 100644
--- a/src/grilo.c
+++ b/src/grilo.c
@@ -49,6 +49,8 @@ static const gchar *plugin_path = NULL;
* @argv: (inout) (element-type utf8) (array length=argc) (allow-none): list of arguments
*
* Initializes the Grilo library
+ *
+ * Since: 0.1.6
*/
void
grl_init (gint *argc,
@@ -122,6 +124,8 @@ grl_init (gint *argc,
*
* Returns: a pointer to Grilo's option group. Should be dereferenced
* after use.
+ *
+ * Since: 0.1.6
*/
GOptionGroup *
grl_init_get_option_group (void)
diff --git a/src/grl-log.c b/src/grl-log.c
index 6d5a3a6..7e7dcef 100644
--- a/src/grl-log.c
+++ b/src/grl-log.c
@@ -90,6 +90,8 @@ _grl_log_domain_new_internal (const gchar *name)
* @name: The name for the new log domain
*
* Returns: The new log domain
+ *
+ * Since: 0.1.7
*/
GrlLogDomain *
grl_log_domain_new (const gchar *name)
@@ -388,6 +390,8 @@ _grl_log_free_core_domains (void)
* <note>It's possible to override the log configuration at runtime by
* defining the GRL_DEBUG environment variable to a configuration string
* as described above</note>
+ *
+ * Since: 0.1.7
*/
void
grl_log_configure (const gchar *config)
diff --git a/src/grl-media-plugin.c b/src/grl-media-plugin.c
index 6430a98..d48bab2 100644
--- a/src/grl-media-plugin.c
+++ b/src/grl-media-plugin.c
@@ -89,6 +89,8 @@ grl_media_plugin_set_plugin_info (GrlMediaPlugin *plugin,
* Get the name of the plugin
*
* Returns: the name of the @plugin
+ *
+ * Since: 0.1.1
*/
const gchar *
grl_media_plugin_get_name (GrlMediaPlugin *plugin)
@@ -104,6 +106,8 @@ grl_media_plugin_get_name (GrlMediaPlugin *plugin)
* Get the description of the plugin
*
* Returns: the description of the @plugin
+ *
+ * Since: 0.1.1
*/
const gchar *
grl_media_plugin_get_description (GrlMediaPlugin *plugin)
@@ -119,6 +123,8 @@ grl_media_plugin_get_description (GrlMediaPlugin *plugin)
* Get the version of the plugin
*
* Returns: the version of the @plugin
+ *
+ * Since: 0.1.1
*/
const gchar *
grl_media_plugin_get_version (GrlMediaPlugin *plugin)
@@ -134,6 +140,8 @@ grl_media_plugin_get_version (GrlMediaPlugin *plugin)
* Get the license of the plugin
*
* Returns: the license of the @plugin
+ *
+ * Since: 0.1.1
*/
const gchar *
grl_media_plugin_get_license (GrlMediaPlugin *plugin)
@@ -149,6 +157,8 @@ grl_media_plugin_get_license (GrlMediaPlugin *plugin)
* Get the author of the plugin
*
* Returns: the author of the @plugin
+ *
+ * Since: 0.1.1
*/
const gchar *
grl_media_plugin_get_author (GrlMediaPlugin *plugin)
@@ -164,6 +174,8 @@ grl_media_plugin_get_author (GrlMediaPlugin *plugin)
* Get the site of the plugin
*
* Returns: the site of the @plugin
+ *
+ * Since: 0.1.1
*/
const gchar *
grl_media_plugin_get_site (GrlMediaPlugin *plugin)
@@ -179,6 +191,8 @@ grl_media_plugin_get_site (GrlMediaPlugin *plugin)
* Get the id of the plugin
*
* Returns: the id of the @plugin
+ *
+ * Since: 0.1.1
*/
const gchar *
grl_media_plugin_get_id (GrlMediaPlugin *plugin)
@@ -195,6 +209,8 @@ grl_media_plugin_get_id (GrlMediaPlugin *plugin)
* Get the filename containing the plugin
*
* Returns: the filename containing @plugin
+ *
+ * Since: 0.1.6
*/
const gchar *
grl_media_plugin_get_filename (GrlMediaPlugin *plugin)
@@ -211,6 +227,8 @@ grl_media_plugin_get_filename (GrlMediaPlugin *plugin)
* Get the #GrlPluginRank of the plugin
*
* Returns: the rank of the plugin
+ *
+ * Since: 0.1.3
*/
gint
grl_media_plugin_get_rank (GrlMediaPlugin *plugin)
@@ -230,6 +248,8 @@ grl_media_plugin_get_rank (GrlMediaPlugin *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.1.6
**/
GList *
grl_media_plugin_get_info_keys (GrlMediaPlugin *plugin)
@@ -251,6 +271,8 @@ grl_media_plugin_get_info_keys (GrlMediaPlugin *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.1.6
*/
const gchar *
grl_media_plugin_get_info (GrlMediaPlugin *plugin, const gchar *key)
diff --git a/src/grl-media-source.c b/src/grl-media-source.c
index 48fbf6c..4ed0357 100644
--- a/src/grl-media-source.c
+++ b/src/grl-media-source.c
@@ -1241,6 +1241,8 @@ metadata_full_resolution_ctl_cb (GrlMediaSource *source,
* This method is asynchronous.
*
* Returns: the operation identifier
+ *
+ * Since: 0.1.4
*/
guint
grl_media_source_browse (GrlMediaSource *source,
@@ -1380,6 +1382,8 @@ grl_media_source_browse (GrlMediaSource *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.1.6
*/
GList *
grl_media_source_browse_sync (GrlMediaSource *source,
@@ -1438,6 +1442,8 @@ grl_media_source_browse_sync (GrlMediaSource *source,
* This method is asynchronous.
*
* Returns: the operation identifier
+ *
+ * Since: 0.1.1
*/
guint
grl_media_source_search (GrlMediaSource *source,
@@ -1566,6 +1572,8 @@ grl_media_source_search (GrlMediaSource *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.1.6
*/
GList *
grl_media_source_search_sync (GrlMediaSource *source,
@@ -1628,6 +1636,8 @@ grl_media_source_search_sync (GrlMediaSource *source,
* This method is asynchronous.
*
* Returns: the operation identifier
+ *
+ * Since: 0.1.1
*/
guint
grl_media_source_query (GrlMediaSource *source,
@@ -1758,6 +1768,8 @@ grl_media_source_query (GrlMediaSource *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.1.6
*/
GList *
grl_media_source_query_sync (GrlMediaSource *source,
@@ -1814,6 +1826,8 @@ grl_media_source_query_sync (GrlMediaSource *source,
* This method is asynchronous.
*
* Returns: the operation identifier
+ *
+ * Since: 0.1.6
*/
guint
grl_media_source_metadata (GrlMediaSource *source,
@@ -1924,6 +1938,8 @@ grl_media_source_metadata (GrlMediaSource *source,
* This method is synchronous.
*
* Returns: (transfer full): a filled #GrlMedia
+ *
+ * Since: 0.1.6
*/
GrlMedia *
grl_media_source_metadata_sync (GrlMediaSource *source,
@@ -2003,6 +2019,8 @@ grl_media_source_supported_operations (GrlMetadataSource *metadata_source)
*
* The derived class must implement the cancel vmethod in order to
* honor the request.
+ *
+ * Since: 0.1.1
*/
void
grl_media_source_cancel (GrlMediaSource *source, guint operation_id)
@@ -2040,6 +2058,8 @@ grl_media_source_cancel (GrlMediaSource *source, guint operation_id)
* @data: the data to attach
*
* Attach a pointer to the specific operation.
+ *
+ * Since: 0.1.1
*/
void
grl_media_source_set_operation_data (GrlMediaSource *source,
@@ -2059,6 +2079,8 @@ grl_media_source_set_operation_data (GrlMediaSource *source,
* Obtains the previously attached data
*
* Returns: (transfer none): The previously attached data.
+ *
+ * Since: 0.1.1
*/
gpointer
grl_media_source_get_operation_data (GrlMediaSource *source,
@@ -2076,6 +2098,8 @@ grl_media_source_get_operation_data (GrlMediaSource *source,
* TBD
*
* Returns: the assigned threshold
+ *
+ * Since: 0.1.1
*/
guint
grl_media_source_get_auto_split_threshold (GrlMediaSource *source)
@@ -2090,6 +2114,8 @@ grl_media_source_get_auto_split_threshold (GrlMediaSource *source)
* @threshold: the threshold to request
*
* TBD
+ *
+ * Since: 0.1.1
*/
void
grl_media_source_set_auto_split_threshold (GrlMediaSource *source,
@@ -2110,6 +2136,8 @@ grl_media_source_set_auto_split_threshold (GrlMediaSource *source,
* Store the @media into the @parent container
*
* This method is asynchronous.
+ *
+ * Since: 0.1.4
*/
void
grl_media_source_store (GrlMediaSource *source,
@@ -2178,6 +2206,8 @@ grl_media_source_store (GrlMediaSource *source,
* Store the @media into the @parent container.
*
* This method is synchronous.
+ *
+ * Since: 0.1.6
*/
void
grl_media_source_store_sync (GrlMediaSource *source,
@@ -2218,6 +2248,8 @@ grl_media_source_store_sync (GrlMediaSource *source,
* Remove a @media from the @source repository.
*
* This method is asynchronous.
+ *
+ * Since: 0.1.4
*/
void
grl_media_source_remove (GrlMediaSource *source,
@@ -2271,6 +2303,8 @@ grl_media_source_remove (GrlMediaSource *source,
* Remove a @media from the @source repository.
*
* This method is synchronous.
+ *
+ * Since: 0.1.6
*/
void
grl_media_source_remove_sync (GrlMediaSource *source,
@@ -2310,6 +2344,8 @@ grl_media_source_remove_sync (GrlMediaSource *source,
* Returns: %TRUE if it can, %FALSE otherwise.
*
* This method is synchronous.
+ *
+ * Since: 0.1.7
*/
gboolean
grl_media_source_test_media_from_uri (GrlMediaSource *source,
@@ -2344,6 +2380,8 @@ grl_media_source_test_media_from_uri (GrlMediaSource *source,
* resolution.
*
* This method is asynchronous.
+ *
+ * Since: 0.1.7
*/
void
grl_media_source_get_media_from_uri (GrlMediaSource *source,
diff --git a/src/grl-metadata-key.c b/src/grl-metadata-key.c
index a799d17..801e57c 100644
--- a/src/grl-metadata-key.c
+++ b/src/grl-metadata-key.c
@@ -319,6 +319,8 @@ GRL_METADATA_KEY_STUDIO =
* Retrieves the name associated with the key
*
* Returns: The name of the key
+ *
+ * Since: 0.1.6
*/
const gchar *
grl_metadata_key_get_name (GrlKeyID key)
@@ -333,6 +335,8 @@ grl_metadata_key_get_name (GrlKeyID key)
* Retrieves the description associated with the key
*
* Returns: the description of the key
+ *
+ * Since: 0.1.6
*/
const gchar *
grl_metadata_key_get_desc (GrlKeyID key)
diff --git a/src/grl-metadata-source.c b/src/grl-metadata-source.c
index c2f04c0..97f887a 100644
--- a/src/grl-metadata-source.c
+++ b/src/grl-metadata-source.c
@@ -557,6 +557,8 @@ filter_key_list (GrlMetadataSource *source,
* source can fetch and store.
*
* Returns: (element-type GObject.ParamSpec) (transfer none): a #GList with the keys
+ *
+ * Since: 0.1.1
*/
const GList *
grl_metadata_source_supported_keys (GrlMetadataSource *source)
@@ -578,6 +580,8 @@ grl_metadata_source_supported_keys (GrlMetadataSource *source)
* to fetch them.
*
* Returns: (element-type GObject.ParamSpec) (transfer none): a #GList with the keys
+ *
+ * Since: 0.1.1
*/
const GList *
grl_metadata_source_slow_keys (GrlMetadataSource *source)
@@ -600,6 +604,8 @@ grl_metadata_source_slow_keys (GrlMetadataSource *source)
*
* Returns: (element-type GObject.ParamSpec) (transfer none):
* a #GList with the keys, or @NULL if it can not resolve @key_id
+ *
+ * Since: 0.1.1
*/
const GList *
grl_metadata_source_key_depends (GrlMetadataSource *source, GrlKeyID key_id)
@@ -623,6 +629,8 @@ grl_metadata_source_key_depends (GrlMetadataSource *source, GrlKeyID key_id)
*
* Returns: (element-type GObject.ParamSpec) (transfer none):
* a #GList with the keys
+ *
+ * Since: 0.1.4
*/
const GList *
grl_metadata_source_writable_keys (GrlMetadataSource *source)
@@ -650,6 +658,8 @@ grl_metadata_source_writable_keys (GrlMetadataSource *source)
* metadata of the requested keys.
*
* This function is asynchronous and uses the Glib's main loop.
+ *
+ * Since: 0.1.4
*/
void
grl_metadata_source_resolve (GrlMetadataSource *source,
@@ -715,6 +725,8 @@ grl_metadata_source_resolve (GrlMetadataSource *source,
* This function is synchronous.
*
* Returns: (transfer full): the updated #GrlMedia
+ *
+ * Since: 0.1.6
*/
GrlMedia *
grl_metadata_source_resolve_sync (GrlMetadataSource *source,
@@ -763,6 +775,8 @@ grl_metadata_source_resolve_sync (GrlMetadataSource *source,
* Returns: (element-type GObject.ParamSpec) (transfer container):
* if @return_filtered is %TRUE will return the list of intersected keys;
* otherwise %NULL
+ *
+ * Since: 0.1.1
*/
GList *
grl_metadata_source_filter_supported (GrlMetadataSource *source,
@@ -810,6 +824,8 @@ grl_metadata_source_filter_supported (GrlMetadataSource *source,
* Returns: (element-type GObject.ParamSpec) (transfer container):
* if @return_filtered is %TRUE will return the list of intersected keys;
* otherwise %NULL
+ *
+ * Since: 0.1.1
*/
GList *
grl_metadata_source_filter_slow (GrlMetadataSource *source,
@@ -839,6 +855,8 @@ grl_metadata_source_filter_slow (GrlMetadataSource *source,
* Returns: (element-type GObject.ParamSpec) (transfer container):
* if @return_filtered is %TRUE will return the list of intersected keys;
* otherwise %NULL
+ *
+ * Since: 0.1.4
*/
GList *
grl_metadata_source_filter_writable (GrlMetadataSource *source,
@@ -1048,6 +1066,8 @@ grl_metadata_source_setup_full_resolution_mode (GrlMetadataSource *source,
* @source: a metadata source
*
* Returns: the ID of the @source
+ *
+ * Since: 0.1.1
*/
const gchar *
grl_metadata_source_get_id (GrlMetadataSource *source)
@@ -1062,6 +1082,8 @@ grl_metadata_source_get_id (GrlMetadataSource *source)
* @source: a metadata source
*
* Returns: the name of the @source
+ *
+ * Since: 0.1.1
*/
const gchar *
grl_metadata_source_get_name (GrlMetadataSource *source)
@@ -1076,6 +1098,8 @@ grl_metadata_source_get_name (GrlMetadataSource *source)
* @source: a metadata source
*
* Returns: the description of the @source
+ *
+ * Since: 0.1.1
*/
const gchar *
grl_metadata_source_get_description (GrlMetadataSource *source)
@@ -1101,6 +1125,8 @@ grl_metadata_source_get_description (GrlMetadataSource *source)
* shall return this new values for the selected keys.
*
* This function is asynchronous and uses the Glib's main loop.
+ *
+ * Since: 0.1.4
*/
void
grl_metadata_source_set_metadata (GrlMetadataSource *source,
@@ -1166,6 +1192,8 @@ grl_metadata_source_set_metadata (GrlMetadataSource *source,
*
* Returns: (element-type GObject.ParamSpec) (transfer container):
* a #GList of keys that could not be updated, or @NULL
+ *
+ * Since: 0.1.6
*/
GList *
grl_metadata_source_set_metadata_sync (GrlMetadataSource *source,
@@ -1211,6 +1239,8 @@ grl_metadata_source_set_metadata_sync (GrlMetadataSource *source,
*
* Returns: (type uint): a bitwise mangle with the supported operations by
* the source
+ *
+ * Since: 0.1.1
*/
GrlSupportedOps
grl_metadata_source_supported_operations (GrlMetadataSource *source)
diff --git a/src/grl-multiple.c b/src/grl-multiple.c
index fcd7a2c..6bb32b9 100644
--- a/src/grl-multiple.c
+++ b/src/grl-multiple.c
@@ -489,6 +489,8 @@ media_from_uri_cb (GrlMediaSource *source,
* This method is asynchronous.
*
* Returns: the operation identifier
+ *
+ * Since: 0.1.6
*/
guint
grl_multiple_search (const GList *sources,
@@ -562,6 +564,7 @@ grl_multiple_search (const GList *sources,
* Cancel a running multiple search by issuing a cancel operation on each
* source involved involved in the operation.
*
+ * Since: 0.1.6
*/
void
grl_multiple_cancel (guint search_id)
@@ -622,6 +625,8 @@ grl_multiple_cancel (guint search_id)
* This method is synchronous.
*
* Returns: (element-type Grl.Media) (transfer full): a list with #GrlMedia elements
+ *
+ * Since: 0.1.6
*/
GList *
grl_multiple_search_sync (const GList *sources,
@@ -673,6 +678,8 @@ grl_multiple_search_sync (const GList *sources,
* by @uri.
*
* This method is asynchronous.
+ *
+ * Since: 0.1.7
*/
void
grl_multiple_get_media_from_uri (const gchar *uri,
diff --git a/src/grl-plugin-registry.c b/src/grl-plugin-registry.c
index d12c3f4..c33657f 100644
--- a/src/grl-plugin-registry.c
+++ b/src/grl-plugin-registry.c
@@ -274,6 +274,8 @@ get_info_from_plugin_xml (const gchar *xml_path)
* Returns: (transfer none): a new or an already created instance of the registry.
*
* It is NOT MT-safe
+ *
+ * Since: 0.1.6
*/
GrlPluginRegistry *
grl_plugin_registry_get_default (void)
@@ -297,6 +299,8 @@ grl_plugin_registry_get_default (void)
* Register a @source in the @registry with the given @plugin information
*
* Returns: %TRUE if success, %FALSE% otherwise.
+ *
+ * Since: 0.1.7
*/
gboolean
grl_plugin_registry_register_source (GrlPluginRegistry *registry,
@@ -336,6 +340,8 @@ grl_plugin_registry_register_source (GrlPluginRegistry *registry,
* Removes the @source from the @registry hash table
*
* Returns: %TRUE if success, %FALSE% otherwise.
+ *
+ * Since: 0.1.7
*/
gboolean
grl_plugin_registry_unregister_source (GrlPluginRegistry *registry,
@@ -374,6 +380,8 @@ grl_plugin_registry_unregister_source (GrlPluginRegistry *registry,
* @path: a path with plugins
*
* Set this path as part of default paths to load plugins.
+ *
+ * Since: 0.1.6
**/
void
grl_plugin_registry_add_directory (GrlPluginRegistry *registry,
@@ -397,6 +405,8 @@ grl_plugin_registry_add_directory (GrlPluginRegistry *registry,
* Loads a module from shared object file stored in @path
*
* Returns: %TRUE if the module is loaded correctly
+ *
+ * Since: 0.1.7
*/
gboolean
grl_plugin_registry_load (GrlPluginRegistry *registry,
@@ -491,6 +501,8 @@ grl_plugin_registry_load (GrlPluginRegistry *registry,
* a group shared object files.
*
* Returns: %TRUE if the directory is valid.
+ *
+ * Since: 0.1.7
*/
gboolean
grl_plugin_registry_load_directory (GrlPluginRegistry *registry,
@@ -547,6 +559,8 @@ grl_plugin_registry_load_directory (GrlPluginRegistry *registry,
*
* Returns: %FALSE% is all the configured plugin paths are invalid,
* %TRUE% otherwise.
+ *
+ * Since: 0.1.1
*/
gboolean
grl_plugin_registry_load_all (GrlPluginRegistry *registry, GError **error)
@@ -582,6 +596,8 @@ grl_plugin_registry_load_all (GrlPluginRegistry *registry, GError **error)
* This function will search and retrieve a source given its identifier.
*
* Returns: (transfer none): The source found.
+ *
+ * Since: 0.1.1
*/
GrlMediaPlugin *
grl_plugin_registry_lookup_source (GrlPluginRegistry *registry,
@@ -605,6 +621,8 @@ grl_plugin_registry_lookup_source (GrlPluginRegistry *registry,
* Returns: (element-type Grl.MediaPlugin) (transfer container): a #GList of
* available #GrlMediaPlugins<!-- -->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
*/
GList *
grl_plugin_registry_get_sources (GrlPluginRegistry *registry,
@@ -642,6 +660,8 @@ grl_plugin_registry_get_sources (GrlPluginRegistry *registry,
* Returns: (element-type Grl.MediaPlugin) (transfer container): a #GList of
* available #GrlMediaPlugins<!-- -->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
*/
GList *
grl_plugin_registry_get_sources_by_operations (GrlPluginRegistry *registry,
@@ -681,6 +701,8 @@ grl_plugin_registry_get_sources_by_operations (GrlPluginRegistry *registry,
* module's deinit function.
*
* Returns %TRUE% on success.
+ *
+ * Since: 0.1.7
*/
gboolean
grl_plugin_registry_unload (GrlPluginRegistry *registry,
@@ -753,6 +775,8 @@ grl_plugin_registry_unload (GrlPluginRegistry *registry,
*
* Returns: (type GObject.ParamSpec) (transfer none): The #GrlKeyID registered
* or @NULL on error.
+ *
+ * Since: 0.1.7
*/
GrlKeyID
grl_plugin_registry_register_metadata_key (GrlPluginRegistry *registry,
@@ -792,6 +816,8 @@ grl_plugin_registry_register_metadata_key (GrlPluginRegistry *registry,
* Look up for the metadata key with name @key_name.
*
* Returns: (type GObject.ParamSpec) (transfer none): The metadata key, or @NULL if not found
+ *
+ * Since: 0.1.6
*/
GrlKeyID
grl_plugin_registry_lookup_metadata_key (GrlPluginRegistry *registry,
@@ -815,6 +841,8 @@ grl_plugin_registry_lookup_metadata_key (GrlPluginRegistry *registry,
* Returns: (element-type GObject.ParamSpec) (transfer container): a #GList
* with all the available #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
**/
GList *
grl_plugin_registry_get_metadata_keys (GrlPluginRegistry *registry)
@@ -846,6 +874,8 @@ grl_plugin_registry_get_metadata_keys (GrlPluginRegistry *registry)
* @error: error return location or @NULL to ignore
*
* Add a configuration for a plugin/source.
+ *
+ * Since: 0.1.7
*/
gboolean
grl_plugin_registry_add_config (GrlPluginRegistry *registry,
@@ -894,6 +924,8 @@ grl_plugin_registry_add_config (GrlPluginRegistry *registry,
* Load plugin configurations from a .ini-like config file.
*
* Returns: %TRUE on success
+ *
+ * Since: 0.1.7
**/
gboolean
grl_plugin_registry_add_config_from_file (GrlPluginRegistry *registry,
diff --git a/src/grl-util.c b/src/grl-util.c
index d632aed..44b5f2a 100644
--- a/src/grl-util.c
+++ b/src/grl-util.c
@@ -45,6 +45,8 @@
* to satisfy the data, using the smallest page size. If user is limiting page
* size, then more requests to services might be needed. But still page size
* will be an optimal value.
+ *
+ * Since: 0.1.6
**/
void grl_paging_translate (guint skip,
guint count,
@@ -92,6 +94,8 @@ void grl_paging_translate (guint skip,
* Returns a #GList containing the va_list pointers. Use @NULL to finalize them,
*
* Returns: a #GList.
+ *
+ * Since: 0.1.6
**/
GList *
grl_list_from_va (gpointer p, ...)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
