[rygel] librygel-server: Add some MediaContainer docs.



commit 5f39872d0b693018b80a473a81ba445c0b45a450
Author: Murray Cumming <murrayc murrayc com>
Date:   Thu Jan 17 14:00:08 2013 +0100

    librygel-server: Add some MediaContainer docs.

 src/librygel-server/rygel-media-container.vala |   15 +++++++++++++++
 1 files changed, 15 insertions(+), 0 deletions(-)
---
diff --git a/src/librygel-server/rygel-media-container.vala b/src/librygel-server/rygel-media-container.vala
index ffa1828..ba0b168 100644
--- a/src/librygel-server/rygel-media-container.vala
+++ b/src/librygel-server/rygel-media-container.vala
@@ -132,6 +132,14 @@ public abstract class Rygel.MediaContainer : MediaObject {
         }
     }
 
+    /**
+     * Create a media container with the specified details.
+     *
+     * @param id See the id property of the #RygelMediaObject class.
+     * @param parent The parent container, if any.
+     * @param title See the title property of the #RygelMediaObject class.
+     * @param child_count
+     */
     public MediaContainer (string          id,
                            MediaContainer? parent,
                            string          title,
@@ -149,6 +157,13 @@ public abstract class Rygel.MediaContainer : MediaObject {
         this.sub_tree_updates_finished.connect (on_sub_tree_updates_finished);
     }
 
+    /**
+     * Create a root media container with the specified details,
+     * with no parent container, and with an appropriate ID.
+     *
+     * @param title See the title property of the #RygelMediaObject.
+     * @param child_count
+     */
     public MediaContainer.root (string title,
                                 int    child_count) {
         this ("0", null, title, child_count);



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