[rygel/rygel-0-16] server: Add more class documentation.

[Jens Georg <jensgeorg src gnome org>]

commit 9f6b22b527f5802036e42544d245db5e9c802026
Author: Murray Cumming <murrayc openismus com>
Date:   Wed Sep 19 12:35:02 2012 +0200

    server: Add more class documentation.

 src/librygel-server/rygel-logical-expression.vala  |    7 +++++--
 src/librygel-server/rygel-media-art-store.vala     |    6 ++++++
 src/librygel-server/rygel-media-server-plugin.vala |    6 ++++++
 .../rygel-relational-expression.vala               |    7 +++++--
 .../rygel-searchable-container.vala                |   12 ++++++++++++
 5 files changed, 34 insertions(+), 4 deletions(-)
---
diff --git a/src/librygel-server/rygel-logical-expression.vala b/src/librygel-server/rygel-logical-expression.vala
index dbf6492..653f32b 100644
--- a/src/librygel-server/rygel-logical-expression.vala
+++ b/src/librygel-server/rygel-logical-expression.vala
@@ -1,5 +1,6 @@
 /*
  * Copyright (C) 2009 Nokia Corporation.
+ * Copyright (C) 2012 Intel Corporation.
  *
  * Author: Zeeshan Ali (Khattak) <zeeshanak gnome org>
  *
@@ -25,8 +26,10 @@ public enum Rygel.LogicalOperator {
     OR
 }
 
-// Represents a search expression that consists of two search expressions joined
-// by a logical operator
+/**
+ * This is a parsed UPnP search expression consisting of two other search expressions
+ * joined by a boolean operator such as AND or OR.
+ */
 public class Rygel.LogicalExpression :
              Rygel.SearchExpression<LogicalOperator,
                                     SearchExpression,
diff --git a/src/librygel-server/rygel-media-art-store.vala b/src/librygel-server/rygel-media-art-store.vala
index 7ba0487..a1065b6 100644
--- a/src/librygel-server/rygel-media-art-store.vala
+++ b/src/librygel-server/rygel-media-art-store.vala
@@ -1,5 +1,6 @@
 /*
  * Copyright (C) 2010 Jens Georg <mail jensge org>.
+ * Copyright (C) 2012 Intel Corporation.
  *
  * Author: Jens Georg <mail jensge org>
  *
@@ -25,6 +26,11 @@ internal errordomain MediaArtStoreError {
     NO_MEDIA_ART
 }
 
+/**
+ * This maps RygelMusicItem objects to their cached cover art,
+ * implementing the GNOME [[https://live.gnome.org/MediaArtStorageSpec|MediaArt storage specification]]
+ * and the simplified version that Banshee uses.
+ */
 public class Rygel.MediaArtStore : GLib.Object {
     private const string PLACEHOLDER_HASH = "7215ee9c7d9dc229d2921a40e899ec5f";
     private const string invalid_chars = "()[]<>{}_! #$^&*+=|\\/\"'?~";
diff --git a/src/librygel-server/rygel-media-server-plugin.vala b/src/librygel-server/rygel-media-server-plugin.vala
index 28a4e84..19aaf54 100644
--- a/src/librygel-server/rygel-media-server-plugin.vala
+++ b/src/librygel-server/rygel-media-server-plugin.vala
@@ -1,5 +1,6 @@
 /*
  * Copyright (C) 2008,2010 Nokia Corporation.
+ * Copyright (C) 2012 Intel Corporation.
  *
  * Author: Zeeshan Ali (Khattak) <zeeshanak gnome org>
  *                               <zeeshan ali nokia com>
@@ -21,6 +22,11 @@
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
+/**
+ * This is the base class for every Rygel implementation of a UPnP media
+ * server. It should be used either for a real plug-in for the rygel process or used
+ * in-process via the librygel-server API (see the standalone-server.c example).
+ */
 public abstract class Rygel.MediaServerPlugin : Rygel.Plugin {
     private static const string MEDIA_SERVER_DESC_PATH =
                                 BuildConfig.DATA_DIR + "/xml/MediaServer2.xml";
diff --git a/src/librygel-server/rygel-relational-expression.vala b/src/librygel-server/rygel-relational-expression.vala
index 8b1295e..744d37a 100644
--- a/src/librygel-server/rygel-relational-expression.vala
+++ b/src/librygel-server/rygel-relational-expression.vala
@@ -1,5 +1,6 @@
 /*
  * Copyright (C) 2009 Nokia Corporation.
+ * Copyright (C) 2012 Intel Corporation.
  *
  * Author: Zeeshan Ali (Khattak) <zeeshanak gnome org>
  *
@@ -22,8 +23,10 @@
 
 using GUPnP;
 
-// Represents a search expression that consists of two strings joined by a
-// relational operator.
+/**
+ * This is a parsed UPnP search expression consisting of two strings joined by a
+ * relational operator such as such <, <=, ==, !=, >, >=, derivedFrom or exists.
+ */
 public class Rygel.RelationalExpression :
              Rygel.SearchExpression<SearchCriteriaOp,string,string> {
     internal const string CAPS = "@id,@parentID,@refID,upnp:class," +
diff --git a/src/librygel-server/rygel-searchable-container.vala b/src/librygel-server/rygel-searchable-container.vala
index 469dad4..76cd165 100644
--- a/src/librygel-server/rygel-searchable-container.vala
+++ b/src/librygel-server/rygel-searchable-container.vala
@@ -2,6 +2,7 @@
  * Copyright (C) 2008,2010 Zeeshan Ali <zeenix gmail com>.
  * Copyright (C) 2010 MediaNet Inh.
  * Copyright (C) 2010 Nokia Corporation.
+ * Copyright (C) 2012 Intel Corporation.
  *
  * Authors: Zeeshan Ali <zeenix gmail com>
  *          Sunil Mohan Adapa <sunil medhas org>
@@ -26,6 +27,17 @@
 using GUPnP;
 using Gee;
 
+/**
+ * The base class for searchable containers.
+ *
+ * Classes that implement this interface can, for instance:
+ *
+ *  # Allow backends to implement a UPnP Search call using native searching (such as SQL or SPARQL queries).
+ *  # Provide a naÃve default implementation of search by doing a recursive tree walk.
+ *
+ * The search_classes property lists what information this container may be searched
+ * for. It is mapped to upnp:searchClass (with includeDerived assumed to be false),
+ */
 public interface Rygel.SearchableContainer : MediaContainer {
     public abstract ArrayList<string> search_classes { get; set; }