[rygel/docs] renderer: Simple documentation



commit faea749705e12da3292a868cd34d2d8e0725ae10
Author: Murray Cumming <murrayc murrayc com>
Date:   Mon Sep 10 13:53:12 2012 +0200

    renderer: Simple documentation

 src/librygel-renderer/rygel-media-player.vala      |    3 +++
 .../rygel-media-renderer-plugin.vala               |    3 +++
 src/librygel-renderer/rygel-playbin-player.vala    |    3 +++
 src/librygel-renderer/rygel-playbin-plugin.vala    |    3 +++
 4 files changed, 12 insertions(+), 0 deletions(-)
---
diff --git a/src/librygel-renderer/rygel-media-player.vala b/src/librygel-renderer/rygel-media-player.vala
index c139cfb..90cfaaa 100644
--- a/src/librygel-renderer/rygel-media-player.vala
+++ b/src/librygel-renderer/rygel-media-player.vala
@@ -23,6 +23,9 @@
 
 using Gst;
 
+/**
+ * Interface for mapping AVTransport:2 methods to the specific implementation.
+ */
 public interface Rygel.MediaPlayer : GLib.Object {
     public abstract string playback_state { owned get; set; }
     public abstract string? uri { owned get; set; }
diff --git a/src/librygel-renderer/rygel-media-renderer-plugin.vala b/src/librygel-renderer/rygel-media-renderer-plugin.vala
index 549d95b..624ec3e 100644
--- a/src/librygel-renderer/rygel-media-renderer-plugin.vala
+++ b/src/librygel-renderer/rygel-media-renderer-plugin.vala
@@ -21,6 +21,9 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
+/**
+ * Base class for every Rygel UPnP renderer plugin.
+ */
 public class Rygel.MediaRendererPlugin : Rygel.Plugin {
     private static const string MEDIA_RENDERER_DESC_PATH =
                                 BuildConfig.DATA_DIR +
diff --git a/src/librygel-renderer/rygel-playbin-player.vala b/src/librygel-renderer/rygel-playbin-player.vala
index 392f21e..37b0d39 100644
--- a/src/librygel-renderer/rygel-playbin-player.vala
+++ b/src/librygel-renderer/rygel-playbin-player.vala
@@ -26,6 +26,9 @@
 using Gst;
 using GUPnP;
 
+/**
+ * Implementation of RygelMediaPlayer for GStreamer.
+ */
 public class Rygel.Playbin.Player : GLib.Object, Rygel.MediaPlayer {
     private const string TRANSFER_MODE_STREAMING = "Streaming";
     private const string TRANSFER_MODE_INTERACTIVE = "Interactive";
diff --git a/src/librygel-renderer/rygel-playbin-plugin.vala b/src/librygel-renderer/rygel-playbin-plugin.vala
index caac9ce..d4e0770 100644
--- a/src/librygel-renderer/rygel-playbin-plugin.vala
+++ b/src/librygel-renderer/rygel-playbin-plugin.vala
@@ -27,6 +27,9 @@
 using Rygel;
 using Gee;
 
+/**
+ * Implementation of RygelMediaRendererPlugin for GStreamer.
+ */
 public class Rygel.Playbin.Plugin : Rygel.MediaRendererPlugin {
     public const string NAME = "Playbin";
 



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