renderer: Improve Renderer docs slightly.
authorMurray Cumming <murrayc@openismus.com>
Mon, 10 Sep 2012 09:12:36 +0000 (11:12 +0200)
committerMurray Cumming <murrayc@murrayc.com>
Mon, 24 Sep 2012 10:10:21 +0000 (12:10 +0200)
src/librygel-renderer/rygel-playbin-renderer.vala

index d85ae6b..14dd277 100644 (file)
@@ -1,5 +1,6 @@
 /*
  * Copyright (C) 2012 Openismus GmbH.
+ * Copyright (C) 2012 Intel Corporation.
  *
  * Author: Jens Georg <jensg@openismus.com>
  *
@@ -40,19 +41,19 @@ internal class Rygel.Playbin.WrappingPlugin : Rygel.MediaRendererPlugin {
 }
 
 /**
- * Convert a GStreamer Playbin2 element into an UPnP renderer.
+ * A UPnP renderer that uses a GStreamer Playbin2 element.
  *
- * Using Playbin2 as a model it reflects any changes done externally, such as
- * changing the currently played URI, volume, pause/play etc. to UPnP.
+ * Using Gst.Playbin2 as a model, it reflects any changes done externally, such as
+ * changing the currently played URI, volume, pause/play etc., to UPnP.
  *
- * Likewise the playbin can be modified externally using UPnP.
+ * Likewise, the playbin can be modified externally using UPnP.
  */
 public class Rygel.Playbin.Renderer : Rygel.MediaDevice {
     /**
      * Create a new instance of Renderer.
      *
-     * Renderer will instanciate its own instance of playbin.
-     * The Playbin can be accessed by using Player.get_default().playbin
+     * Renderer will instantiate its own instance of Gst.Playbin2.
+     * The Gst.Playbin2 can be accessed by using Player.get_default().playbin
      *
      * @param title Friendly name of the new UPnP renderer on the network.
      */
@@ -63,7 +64,7 @@ public class Rygel.Playbin.Renderer : Rygel.MediaDevice {
     }
 
     /**
-     * Create a new instance of Renderer, wrapping an existing playbin
+     * Create a new instance of Renderer, wrapping an existing Playbin2
      * instance.
      *
      * @param pipeline Instance of Gst.PlayBin2 to wrap.