rygel r304 - in trunk/src: plugins/tracker rygel

[zeeshanak svn gnome org]

Author: zeeshanak
Date: Tue Nov 25 14:44:09 2008
New Revision: 304
URL: http://svn.gnome.org/viewvc/rygel?rev=304&view=rev

Log:
Add some basic doc comments for all classes.

Modified:
   trunk/src/plugins/tracker/rygel-media-tracker.vala
   trunk/src/plugins/tracker/rygel-tracker-container.vala
   trunk/src/plugins/tracker/rygel-tracker-image-item.vala
   trunk/src/plugins/tracker/rygel-tracker-item.vala
   trunk/src/plugins/tracker/rygel-tracker-music-item.vala
   trunk/src/plugins/tracker/rygel-tracker-video-item.vala
   trunk/src/rygel/cstuff.vapi
   trunk/src/rygel/rygel-connection-manager.vala
   trunk/src/rygel/rygel-content-directory.vala
   trunk/src/rygel/rygel-media-container.vala
   trunk/src/rygel/rygel-media-item.vala
   trunk/src/rygel/rygel-media-object.vala
   trunk/src/rygel/rygel-media-receiver-registrar.vala
   trunk/src/rygel/rygel-media-server-factory.vala
   trunk/src/rygel/rygel-media-server.vala
   trunk/src/rygel/rygel-metadata-extractor.vala
   trunk/src/rygel/rygel-plugin-loader.vala
   trunk/src/rygel/rygel-plugin.vala
   trunk/src/rygel/rygel-resource-info.vala

Modified: trunk/src/plugins/tracker/rygel-media-tracker.vala
==============================================================================
--- trunk/src/plugins/tracker/rygel-media-tracker.vala	(original)
+++ trunk/src/plugins/tracker/rygel-media-tracker.vala	Tue Nov 25 14:44:09 2008
@@ -27,6 +27,9 @@
 using GUPnP;
 using DBus;
 
+/**
+ * Implementation of Tracker-based ContentDirectory service.
+ */
 public class Rygel.MediaTracker : ContentDirectory {
     public static const int MAX_REQUESTED_COUNT = 128;
 

Modified: trunk/src/plugins/tracker/rygel-tracker-container.vala
==============================================================================
--- trunk/src/plugins/tracker/rygel-tracker-container.vala	(original)
+++ trunk/src/plugins/tracker/rygel-tracker-container.vala	Tue Nov 25 14:44:09 2008
@@ -27,6 +27,9 @@
 using GUPnP;
 using DBus;
 
+/**
+ * Represents Tracker category.
+ */
 public class Rygel.TrackerContainer : MediaContainer {
     /* class-wide constants */
     private const string TRACKER_SERVICE = "org.freedesktop.Tracker";

Modified: trunk/src/plugins/tracker/rygel-tracker-image-item.vala
==============================================================================
--- trunk/src/plugins/tracker/rygel-tracker-image-item.vala	(original)
+++ trunk/src/plugins/tracker/rygel-tracker-image-item.vala	Tue Nov 25 14:44:09 2008
@@ -27,6 +27,9 @@
 using GUPnP;
 using DBus;
 
+/**
+ * Represents Tracker image item.
+ */
 public class Rygel.TrackerImageItem : TrackerItem {
     public TrackerImageItem (string              id,
                              string              path,

Modified: trunk/src/plugins/tracker/rygel-tracker-item.vala
==============================================================================
--- trunk/src/plugins/tracker/rygel-tracker-item.vala	(original)
+++ trunk/src/plugins/tracker/rygel-tracker-item.vala	Tue Nov 25 14:44:09 2008
@@ -27,6 +27,9 @@
 using GUPnP;
 using DBus;
 
+/**
+ * Represents Tracker item.
+ */
 public abstract class Rygel.TrackerItem : MediaItem {
     protected TrackerContainer parent;
     protected string path;

Modified: trunk/src/plugins/tracker/rygel-tracker-music-item.vala
==============================================================================
--- trunk/src/plugins/tracker/rygel-tracker-music-item.vala	(original)
+++ trunk/src/plugins/tracker/rygel-tracker-music-item.vala	Tue Nov 25 14:44:09 2008
@@ -27,6 +27,9 @@
 using GUPnP;
 using DBus;
 
+/**
+ * Represents Tracker music item.
+ */
 public class Rygel.TrackerMusicItem : TrackerItem {
     public TrackerMusicItem (string              id,
                              string              path,

Modified: trunk/src/plugins/tracker/rygel-tracker-video-item.vala
==============================================================================
--- trunk/src/plugins/tracker/rygel-tracker-video-item.vala	(original)
+++ trunk/src/plugins/tracker/rygel-tracker-video-item.vala	Tue Nov 25 14:44:09 2008
@@ -27,6 +27,9 @@
 using GUPnP;
 using DBus;
 
+/**
+ * Represents Tracker video item.
+ */
 public class Rygel.TrackerVideoItem : TrackerItem {
     public TrackerVideoItem (string              id,
                              string              path,

Modified: trunk/src/rygel/cstuff.vapi
==============================================================================
--- trunk/src/rygel/cstuff.vapi	(original)
+++ trunk/src/rygel/cstuff.vapi	Tue Nov 25 14:44:09 2008
@@ -18,7 +18,13 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
+/**
+ * Glue's our C code to Vala world.
+ */
 namespace CStuff {
+    /**
+     * Holds constants defined by build system.
+     */
     class BuildConfig {
         [CCode (cname = "DATA_DIR")]
         public static const string DATA_DIR;
@@ -27,6 +33,9 @@
         public static const string PLUGIN_DIR;
     }
 
+    /**
+     * Provides utility functions implemented in C.
+     */
     public class Utils {
         [CCode (cname = "get_xml_element")]
         public static weak Xml.Node * get_xml_element (Xml.Node node,

Modified: trunk/src/rygel/rygel-connection-manager.vala
==============================================================================
--- trunk/src/rygel/rygel-connection-manager.vala	(original)
+++ trunk/src/rygel/rygel-connection-manager.vala	Tue Nov 25 14:44:09 2008
@@ -27,6 +27,9 @@
 using GLib;
 using GUPnP;
 
+/**
+ * Basic implementation of UPnP ConnectionManager service version 2.
+ */
 public class Rygel.ConnectionManager : Service {
     public const string UPNP_ID = "urn:upnp-org:serviceId:ConnectionManager";
     public const string UPNP_TYPE =

Modified: trunk/src/rygel/rygel-content-directory.vala
==============================================================================
--- trunk/src/rygel/rygel-content-directory.vala	(original)
+++ trunk/src/rygel/rygel-content-directory.vala	Tue Nov 25 14:44:09 2008
@@ -26,10 +26,18 @@
 
 using GUPnP;
 
+/**
+ * Errors used by ContentDirectory and deriving classes.
+ */
 public errordomain Rygel.ContentDirectoryError {
     NO_SUCH_OBJECT = 701
 }
 
+/**
+ * Basic implementation of UPnP ContentDirectory service version 2. Most often
+ * plugins will provide a child of this class. The inheriting classes should
+ * override add_children_metadata and add_metadata virtual methods.
+ */
 public class Rygel.ContentDirectory: Service {
     public const string UPNP_ID = "urn:upnp-org:serviceId:ContentDirectory";
     public const string UPNP_TYPE =

Modified: trunk/src/rygel/rygel-media-container.vala
==============================================================================
--- trunk/src/rygel/rygel-media-container.vala	(original)
+++ trunk/src/rygel/rygel-media-container.vala	Tue Nov 25 14:44:09 2008
@@ -24,6 +24,10 @@
 
 using GUPnP;
 
+/**
+ * Represents a container (folder) for media items and containers. Provides
+ * basic serialization (to DIDLLiteWriter) implementation.
+ */
 public class Rygel.MediaContainer : MediaObject {
     public uint child_count;
 

Modified: trunk/src/rygel/rygel-media-item.vala
==============================================================================
--- trunk/src/rygel/rygel-media-item.vala	(original)
+++ trunk/src/rygel/rygel-media-item.vala	Tue Nov 25 14:44:09 2008
@@ -24,6 +24,10 @@
 
 using GUPnP;
 
+/**
+ * Represents a media (Music, Video and Image) item. Provides basic
+ * serialization (to DIDLLiteWriter) implementation.
+ */
 public class Rygel.MediaItem : MediaObject {
     public static const string IMAGE_CLASS = "object.item.imageItem";
     public static const string VIDEO_CLASS = "object.item.videoItem";

Modified: trunk/src/rygel/rygel-media-object.vala
==============================================================================
--- trunk/src/rygel/rygel-media-object.vala	(original)
+++ trunk/src/rygel/rygel-media-object.vala	Tue Nov 25 14:44:09 2008
@@ -24,6 +24,10 @@
 
 using GUPnP;
 
+/**
+ * Represents a media object (container and item). Subclasses should implement
+ * the abstract serialize method.
+ */
 public abstract class Rygel.MediaObject {
     public string id;
     public string parent_id;

Modified: trunk/src/rygel/rygel-media-receiver-registrar.vala
==============================================================================
--- trunk/src/rygel/rygel-media-receiver-registrar.vala	(original)
+++ trunk/src/rygel/rygel-media-receiver-registrar.vala	Tue Nov 25 14:44:09 2008
@@ -24,6 +24,9 @@
 
 using GUPnP;
 
+/**
+ * Basic implementation of MS MediaReceiverRegistrar service version 1.
+ */
 public class Rygel.MediaReceiverRegistrar: Service {
     public const string UPNP_ID =
                     "urn:microsoft.com:serviceId:X_MS_MediaReceiverRegistrar";

Modified: trunk/src/rygel/rygel-media-server-factory.vala
==============================================================================
--- trunk/src/rygel/rygel-media-server-factory.vala	(original)
+++ trunk/src/rygel/rygel-media-server-factory.vala	Tue Nov 25 14:44:09 2008
@@ -28,6 +28,10 @@
 using GConf;
 using CStuff;
 
+/**
+ * Factory for MediaServer objects. Give it a plugin and it will create a
+ * MediaServer device for that.
+ */
 public class Rygel.MediaServerFactory {
     public static const string DESC_DOC = "xml/description.xml";
     public static const string XBOX_DESC_DOC = "xml/description-xbox360.xml";
@@ -209,7 +213,8 @@
         this.add_services_to_desc (device_element, plugin);
     }
 
-    /* Fills the description doc @doc with a friendly name, and UDN from gconf.
+    /**
+     * Fills the description doc @doc with a friendly name, and UDN from gconf.
      * If these keys are not present in gconf, they are set with default values.
      */
     private void set_friendly_name_and_udn (Xml.Node *device_element,

Modified: trunk/src/rygel/rygel-media-server.vala
==============================================================================
--- trunk/src/rygel/rygel-media-server.vala	(original)
+++ trunk/src/rygel/rygel-media-server.vala	Tue Nov 25 14:44:09 2008
@@ -27,6 +27,9 @@
 using GConf;
 using CStuff;
 
+/**
+ * Represents a MediaServer device.
+ */
 public class Rygel.MediaServer: RootDevice {
     private List<ServiceInfo> services;   /* Services we implement */
 

Modified: trunk/src/rygel/rygel-metadata-extractor.vala
==============================================================================
--- trunk/src/rygel/rygel-metadata-extractor.vala	(original)
+++ trunk/src/rygel/rygel-metadata-extractor.vala	Tue Nov 25 14:44:09 2008
@@ -34,6 +34,11 @@
     ELEMENT = 5     /* stream handled by an element */
 }
 
+/**
+ * Metadata extractor based on Gstreamer. Just set the URI of the media on the
+ * uri property, it will extact the metadata for you and emit signal
+ * metadata_available for each key/value pair extracted.
+ */
 public class Rygel.MetadataExtractor: GLib.Object {
 
     /* TODO: Use tagbin instead once it's ready */

Modified: trunk/src/rygel/rygel-plugin-loader.vala
==============================================================================
--- trunk/src/rygel/rygel-plugin-loader.vala	(original)
+++ trunk/src/rygel/rygel-plugin-loader.vala	Tue Nov 25 14:44:09 2008
@@ -26,6 +26,11 @@
 using CStuff;
 using GUPnP;
 
+/**
+ * Responsible for plugin loading. Probes for shared library files in a specific
+ * directry and tries to grab a function with a specific name and signature,
+ * calls it and expects a Plugin instance in return.
+ */
 public class Rygel.PluginLoader : Object {
     /* We need to keep the modules somewhere */
     private List<Module> modules;

Modified: trunk/src/rygel/rygel-plugin.vala
==============================================================================
--- trunk/src/rygel/rygel-plugin.vala	(original)
+++ trunk/src/rygel/rygel-plugin.vala	Tue Nov 25 14:44:09 2008
@@ -26,6 +26,10 @@
 using Gee;
 using GUPnP;
 
+/**
+ * Represents a Rygel plugin. Plugins are supposed to provide an object of this
+ * class or a subclass.
+ */
 public class Rygel.Plugin : GUPnP.ResourceFactory {
     public string name;
 

Modified: trunk/src/rygel/rygel-resource-info.vala
==============================================================================
--- trunk/src/rygel/rygel-resource-info.vala	(original)
+++ trunk/src/rygel/rygel-resource-info.vala	Tue Nov 25 14:44:09 2008
@@ -26,6 +26,10 @@
 using Gee;
 using GUPnP;
 
+/**
+ * Holds information about a particular resource (device and service)
+ * implementation.
+ */
 public class Rygel.ResourceInfo {
     public string upnp_type;
     public string upnp_id;