server: VisualItem, ImageItem, VideoItem: Document some properties.

The color depth documentation is from the UPnP ContentDirectory
specification.

diff --git a/src/librygel-server/rygel-image-item.vala b/src/librygel-server/rygel-image-item.vala
index 9629a81..23d7e18 100644 (file)
--- a/src/librygel-server/rygel-image-item.vala
+++ b/src/librygel-server/rygel-image-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>
@@ -31,8 +32,25 @@ using Gee;
 public class Rygel.ImageItem : MediaItem, VisualItem {
     public new const string UPNP_CLASS = "object.item.imageItem";
 
+    //TODO: This property documentation is not used.
+    //See valadoc bug: https://bugzilla.gnome.org/show_bug.cgi?id=684367
+
+    /**
+     * The width of the image in pixels.
+     * A value of -1 means that the width is unknown and will not, or did not, appear in DIDL-Lite XML.
+     */
     public int width { get; set; default = -1; }
+
+    /**
+     * The height of the image in pixels.
+     * A value of -1 means that the height is unknown and will not, or did not, appear in DIDL-Lite XML.
+     */
     public int height { get; set; default = -1; }
+
+    /**
+     *The number of bits per pixel used to represent the image resource.
+     * A value of -1 means that the color depth is unknown and will not, or did not, appear in DIDL-Lite XML.
+     */
     public int color_depth { get; set; default = -1; }
 
     public ArrayList<Thumbnail> thumbnails { get; protected set; }

diff --git a/src/librygel-server/rygel-video-item.vala b/src/librygel-server/rygel-video-item.vala
index d5c02d9..f443e7b 100644 (file)
--- a/src/librygel-server/rygel-video-item.vala
+++ b/src/librygel-server/rygel-video-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>
@@ -34,8 +35,25 @@ public class Rygel.VideoItem : AudioItem, VisualItem {
 
     public string author;
 
+    //TODO: This property documentation is not used.
+    //See valadoc bug: https://bugzilla.gnome.org/show_bug.cgi?id=684367
+
+    /**
+     * The width of the item in pixels.
+     * A value of -1 means that the width is unknown and will not, or did not, appear in DIDL-Lite XML.
+     */
     public int width { get; set; default = -1; }
+
+    /**
+     * The height of the item in pixels.
+     * A value of -1 means that the height is unknown and will not, or did not, appear in DIDL-Lite XML.
+     */
     public int height { get; set; default = -1; }
+
+    /**
+     * The number of bits per pixel used to represent the video resource.
+     * A value of -1 means that the color depth is unknown and will not, or did not, appear in DIDL-Lite XML.
+     */
     public int color_depth { get; set; default = -1; }
 
     public ArrayList<Thumbnail> thumbnails { get; protected set; }

diff --git a/src/librygel-server/rygel-visual-item.vala b/src/librygel-server/rygel-visual-item.vala
index bd0a043..3432ab0 100644 (file)
--- a/src/librygel-server/rygel-visual-item.vala
+++ b/src/librygel-server/rygel-visual-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,8 +31,23 @@ using Gst;
  * An interface that visual (video and image) items must implement.
  */
 public interface Rygel.VisualItem : MediaItem {
+
+    /**
+     * The width of the item in pixels.
+     * A value of -1 means that the width is unknown and will not, or did not, appear in DIDL-Lite XML.
+     */
     public abstract int width { get; set; }
+
+    /**
+     * The height of the item in pixels.
+     * A value of -1 means that the height is unknown and will not, or did not, appear in DIDL-Lite XML.
+     */
     public abstract int height { get; set; }
+
+    /**
+     * The number of bits per pixel used to represent the video or image resource.
+     * A value of -1 means that the color depth is unknown and will not, or did not, appear in DIDL-Lite XML.
+     */
     public abstract int color_depth { get; set; }
 
     public abstract ArrayList<Thumbnail> thumbnails { get; protected set; }