[grilo/0.1.x] data: Fixed documentation.
- From: Juan A. Suarez Romero <jasuarez src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [grilo/0.1.x] data: Fixed documentation.
- Date: Tue, 7 Jun 2011 06:02:22 +0000 (UTC)
commit 9c3761dcc2638329c3b2550a06560eda6524b465
Author: Iago Toral Quiroga <itoral igalia com>
Date: Fri Jun 3 16:31:43 2011 +0200
data: Fixed documentation.
src/data/grl-data.c | 11 +++++++----
1 files changed, 7 insertions(+), 4 deletions(-)
---
diff --git a/src/data/grl-data.c b/src/data/grl-data.c
index 45723b9..f09b41b 100644
--- a/src/data/grl-data.c
+++ b/src/data/grl-data.c
@@ -24,13 +24,16 @@
/**
* SECTION:grl-data
- * @short_description: Low-level class to store data
+ * @short_description: Low-level class for storing metadata information about
+ * media resources provided by #GrlMediaSource objects.
* @see_also: #GrlMedia, #GrlMediaBox, #GrlMediaVideo, #GrlMediaAudio,
* #GrlMediaImage
*
- * This class acts as dictionary where keys and their values can be stored. It
- * is suggested to better high level classes, like #GrlMedia, which
- * provides functions to access known properties.
+ * This class acts as a generic metadata dictionary where metadata keys
+ * and their values can be stored.
+ * Usually, application and plugin developers would interact with specific
+ * subclasses of #GrlData, like #GrlMedia or #GrlMediaVideo, which provide
+ * specific API to manipulate well known attributes of these media types.
*/
#include "grl-data.h"
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]