[rygel] RygelMediaObject: Document the title syntax.

[Murray Cumming <murrayc src gnome org>]

commit 4e96c8c5a7e9b099e1a353322bfe3c1f762fa799
Author: Murray Cumming <murrayc murrayc com>
Date:   Thu Jan 17 11:52:59 2013 +0100

    RygelMediaObject: Document the title syntax.

 src/librygel-server/rygel-media-object.vala |   13 +++++++++----
 1 files changed, 9 insertions(+), 4 deletions(-)
---
diff --git a/src/librygel-server/rygel-media-object.vala b/src/librygel-server/rygel-media-object.vala
index af5eafb..09bbcdb 100644
--- a/src/librygel-server/rygel-media-object.vala
+++ b/src/librygel-server/rygel-media-object.vala
@@ -72,14 +72,19 @@ public abstract class Rygel.MediaObject : GLib.Object {
 
     private string _title;
 
+    /* Note that the @@ in the doc comment here is a way of escaping @ in valadoc,
+     * so the real syntax is, for instance, @REALNAME@, which is what appears in
+     * the generated HTML.
+     */
+
     /**
      * The human-readable title of this container or item.
      * These variables will be substituted:
      *
-     * - @REALNAME@< ill be subsituted by the user's real name.
-     * - @USERNAME@ will be substituted by the users's login ID.
-     * - @HOSTNAME@ will be substituted by the name of the machine.
-     * - @ADDRESS@ will be substited by the 
+     *  - @@REALNAME@ will be substituted by the user's real name.
+     *  - @@USERNAME@ will be substituted by the users's login ID.
+     *  - @@HOSTNAME@ will be substituted by the name of the machine.
+     *  - @@ADDRESS@ will be substituted by the IP address of network interface used for the UpNP communication.
      */
     public string title {
         get {