[rygel] docs: librygel-core: Document MediaDevice



commit e5019d5e4c34c5c1322cc35b2407aabd010cae1c
Author: Murray Cumming <murrayc murrayc com>
Date:   Mon Jan 28 10:39:51 2013 +0100

    docs: librygel-core: Document MediaDevice

 src/librygel-core/rygel-media-device.vala |    9 ++++++++-
 1 files changed, 8 insertions(+), 1 deletions(-)
---
diff --git a/src/librygel-core/rygel-media-device.vala b/src/librygel-core/rygel-media-device.vala
index 38bb1fa..c98fd59 100644
--- a/src/librygel-core/rygel-media-device.vala
+++ b/src/librygel-core/rygel-media-device.vala
@@ -34,6 +34,13 @@ internal class Rygel.DeviceContext {
     }
 }
 
+/**
+ * This is a base class for implementations of UPnP devices,
+ * such as RygelMediaServer and RygelMediaRenderer.
+ *
+ * Use rygel_media_device_add_interface() to allow this
+ * device to respond to UPnP messages on a network interface.
+ */
 public abstract class Rygel.MediaDevice : Object {
     private ArrayList<string> interfaces;
     private HashMap<string, Context> contexts;
@@ -63,7 +70,7 @@ public abstract class Rygel.MediaDevice : Object {
      * Add a network interface the device should listen on.
      *
      * If the network interface is not already up, it will be used as soon as
-     * it's ready, otherwise it's used right away.
+     * it's ready. Otherwise it's used right away.
      *
      * @param iface Name of the network interface, e.g. eth0
      */



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