[PATCH 06/13] core: Added gtk-doc tags to grl-media-audio



---
 src/data/grl-media-audio.c |   65 ++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 65 insertions(+), 0 deletions(-)

diff --git a/src/data/grl-media-audio.c b/src/data/grl-media-audio.c
index c7e3481..6568056 100644
--- a/src/data/grl-media-audio.c
+++ b/src/data/grl-media-audio.c
@@ -79,6 +79,13 @@ grl_media_audio_new (void)
                                   NULL));
 }
 
+/**
+ * grl_media_audio_set_artist:
+ * @data: the media instance
+ * @artist: the audio's artist
+ *
+ * Set the artist of the audio
+ */
 void
 grl_media_audio_set_artist (GrlMediaAudio *data, const gchar *artist)
 {
@@ -86,6 +93,13 @@ grl_media_audio_set_artist (GrlMediaAudio *data, const gchar *artist)
                        artist);
 }
 
+/**
+ * grl_media_audio_set_album:
+ * @data: the media instance
+ * @album: the audio's album
+ *
+ * Set the album of the audio
+ */
 void
 grl_media_audio_set_album (GrlMediaAudio *data, const gchar *album)
 {
@@ -93,6 +107,13 @@ grl_media_audio_set_album (GrlMediaAudio *data, const gchar *album)
                        album);
 }
 
+/**
+ * grl_media_audio_set_genre:
+ * @data: the media instance
+ * @genre: the audio's genre
+ *
+ * Set the genre of the audio
+ */
 void
 grl_media_audio_set_genre (GrlMediaAudio *data, const gchar *genre)
 {
@@ -100,6 +121,13 @@ grl_media_audio_set_genre (GrlMediaAudio *data, const gchar *genre)
                        genre);
 }
 
+/**
+ * grl_media_audio_set_lyrics:
+ * @data: the media instance
+ * @lyrics: the audio's lyrics
+ *
+ * Set the lyrics of the audio
+ */
 void
 grl_media_audio_set_lyrics (GrlMediaAudio *data, const gchar *lyrics)
 {
@@ -107,6 +135,13 @@ grl_media_audio_set_lyrics (GrlMediaAudio *data, const gchar *lyrics)
                        lyrics);
 }
 
+/**
+ * grl_media_audio_set_bitrate:
+ * @data: the media instance
+ * @bitrate: the audio's bitrate
+ *
+ * Set the bitrate of the audio
+ */
 void
 grl_media_audio_set_bitrate (GrlMediaAudio *data, gint bitrate)
 {
@@ -114,30 +149,60 @@ grl_media_audio_set_bitrate (GrlMediaAudio *data, gint bitrate)
                     bitrate);
 }
 
+/**
+ * grl_media_audio_get_artist:
+ * @data: the media instance
+ *
+ * Returns: (type utf8) (transfer none): the artist of the audio
+ */
 const gchar *
 grl_media_audio_get_artist (GrlMediaAudio *data)
 {
   return grl_data_get_string (GRL_DATA (data), GRL_METADATA_KEY_ARTIST);
 }
 
+/**
+ * grl_media_audio_get_album:
+ * @data: the media instance
+ *
+ * Returns: (type utf8) (transfer none): the album of the audio
+ */
 const gchar *
 grl_media_audio_get_album (GrlMediaAudio *data)
 {
   return grl_data_get_string (GRL_DATA (data), GRL_METADATA_KEY_ALBUM);
 }
 
+/**
+ * grl_media_audio_get_genre:
+ * @data: the media instance
+ *
+ * Returns: (type utf8) (transfer none): the genre of the audio
+ */
 const gchar *
 grl_media_audio_get_genre (GrlMediaAudio *data)
 {
   return grl_data_get_string (GRL_DATA (data), GRL_METADATA_KEY_GENRE);
 }
 
+/**
+ * grl_media_audio_get_lyrics:
+ * @data: the media instance
+ *
+ * Returns: (type utf8) (transfer none): the lyrics of the audio
+ */
 const gchar *
 grl_media_audio_get_lyrics (GrlMediaAudio *data)
 {
   return grl_data_get_string (GRL_DATA (data), GRL_METADATA_KEY_LYRICS);
 }
 
+/**
+ * grl_media_audio_get_bitrate:
+ * @data: the media instance
+ *
+ * Returns: the bitrate of the audio
+ */
 gint
 grl_media_audio_get_bitrate (GrlMediaAudio *data)
 {
-- 
1.7.0.4



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]