[PATCH 1/8] doc: Improve GrlMediaAudio documentation



---
 src/data/grl-media-audio.c |    9 +++++----
 src/data/grl-media-audio.h |    6 ++++++
 2 files changed, 11 insertions(+), 4 deletions(-)

diff --git a/src/data/grl-media-audio.c b/src/data/grl-media-audio.c
index 8c4c69d..fd5618a 100644
--- a/src/data/grl-media-audio.c
+++ b/src/data/grl-media-audio.c
@@ -22,12 +22,13 @@
  *
  */
 
-/*
- * A multimedia data for audio.
+/**
+ * SECTION:grl-media-audio
+ * @short_description: A multimedia data for audio
+ * @see_also: #GrlConfig, #GrlMediaBox, #GrlMediaVideo, #GrlMediaImage
  *
  * This high level class represents an audio multimedia item. It has methods to
- * set and get properties like album, and so on.
- *
+ * set and get properties like artist, album, and so on.
  */
 
 #include "grl-media-audio.h"
diff --git a/src/data/grl-media-audio.h b/src/data/grl-media-audio.h
index 500e011..45cfbfa 100644
--- a/src/data/grl-media-audio.h
+++ b/src/data/grl-media-audio.h
@@ -63,6 +63,12 @@ G_BEGIN_DECLS
 typedef struct _GrlMediaAudio      GrlMediaAudio;
 typedef struct _GrlMediaAudioClass GrlMediaAudioClass;
 
+/**
+ * GrlMediaAudioClass:
+ * @parent_class: the parent class structure
+ *
+ * Grilo Media audio Class
+ */
 struct _GrlMediaAudioClass
 {
   GrlMediaClass parent_class;
-- 
1.7.0.4



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