[rygel] server: MediaObject, MediaItem: Slightly more documentation.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [rygel] server: MediaObject, MediaItem: Slightly more documentation.
- Date: Mon, 24 Sep 2012 10:19:12 +0000 (UTC)
commit 61bbda942e54228221e8cc70e0c23f2a314216f5
Author: Murray Cumming <murrayc openismus com>
Date: Mon Sep 17 12:42:04 2012 +0200
server: MediaObject, MediaItem: Slightly more documentation.
Mention the derived classes, in particular because valadoc gtkdoc
does not show the hierarchy.
Also mention that they correspond to parts of DIDL-Lite in the
ContentDirectory spec.
src/librygel-server/rygel-media-item.vala | 5 ++++-
src/librygel-server/rygel-media-object.vala | 9 ++++++++-
2 files changed, 12 insertions(+), 2 deletions(-)
---
diff --git a/src/librygel-server/rygel-media-item.vala b/src/librygel-server/rygel-media-item.vala
index 56e3525..d43c2ae 100644
--- a/src/librygel-server/rygel-media-item.vala
+++ b/src/librygel-server/rygel-media-item.vala
@@ -1,6 +1,7 @@
/*
* Copyright (C) 2008 Zeeshan Ali <zeenix gmail com>.
* Copyright (C) 2010 Nokia Corporation.
+ * Copyright (C) 2012 Intel Corporation.
*
* Author: Zeeshan Ali (Khattak) <zeeshanak gnome org>
* <zeeshan ali nokia com>
@@ -30,7 +31,9 @@ private errordomain Rygel.MediaItemError {
}
/**
- * Represents a media (Music, Video and Image) item.
+ * Represents a media item (Music, Video or Image).
+ *
+ * These objects correspond to items in the UPnP ContentDirectory's DIDL-Lite XML.
*/
public abstract class Rygel.MediaItem : MediaObject {
public string date;
diff --git a/src/librygel-server/rygel-media-object.vala b/src/librygel-server/rygel-media-object.vala
index b5ffcfe..d8d9ca9 100644
--- a/src/librygel-server/rygel-media-object.vala
+++ b/src/librygel-server/rygel-media-object.vala
@@ -1,5 +1,6 @@
/*
* Copyright (C) 2008 Zeeshan Ali <zeenix gmail com>.
+ * Copyright (C) 2012 Intel Corporation.
*
* Author: Zeeshan Ali <zeenix gmail com>
*
@@ -24,7 +25,13 @@ using GUPnP;
using Gee;
/**
- * Represents a media object (container and item).
+ * Represents a media object (container or item).
+ *
+ * The derived RygelMediaContainer class represents a container,
+ * and the derived RygelMediaItem classes (RygelAudioItem,
+ * RygelImageItem and RygelVideoItem) represent media items.
+ *
+ * These objects correspond to items and containers in the UPnP ContentDirectory's DIDL-Lite XML.
*/
public abstract class Rygel.MediaObject : GLib.Object {
private static Regex real_name_regex;
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]