[PATCH 2/8] doc: Improve GrlMediaImage documentation
- From: Simón Pena <spenap gmail com>
- To: grilo-list gnome org
- Subject: [PATCH 2/8] doc: Improve GrlMediaImage documentation
- Date: Tue, 21 Sep 2010 23:49:20 +0200
---
src/data/grl-media-image.c | 9 +++++----
src/data/grl-media-image.h | 6 ++++++
2 files changed, 11 insertions(+), 4 deletions(-)
diff --git a/src/data/grl-media-image.c b/src/data/grl-media-image.c
index 7e36f13..2f94955 100644
--- a/src/data/grl-media-image.c
+++ b/src/data/grl-media-image.c
@@ -22,12 +22,13 @@
*
*/
-/*
- * A multimedia data for image.
+/**
+ * SECTION:grl-media-image
+ * @short_description: A multimedia data for image
+ * @see_also: #GrlConfig, #GrlMediaBox, #GrlMediaAudio, #GrlMediaVideo
*
* This high level class represents an image multimedia item. It has methods to
- * set and get properties like framerate, width, height, and so on.
- *
+ * set and get the size, width and height properties
*/
#include "grl-media-image.h"
diff --git a/src/data/grl-media-image.h b/src/data/grl-media-image.h
index 5e990f4..8828b1d 100644
--- a/src/data/grl-media-image.h
+++ b/src/data/grl-media-image.h
@@ -63,6 +63,12 @@ G_BEGIN_DECLS
typedef struct _GrlMediaImage GrlMediaImage;
typedef struct _GrlMediaImageClass GrlMediaImageClass;
+/**
+ * GrlMediaImageClass:
+ * @parent_class: the parent class structure
+ *
+ * Grilo Media image Class
+ */
struct _GrlMediaImageClass
{
GrlMediaClass parent_class;
--
1.7.0.4
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]