Merge branch 'master' of ssh://git.freedesktop.org/git/zeitgeist/zeitgeist

7 files changed, 40 insertions, 39 deletions

diff --git a/.gitignore b/.gitignore
index d0037687..7c9147e7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -94,3 +94,5 @@ test/c/test-symbols
 test/c/test-timerange
 test/c/test-timestamp
 test/direct/*-test
+doc/libzeitgeist/docs_c
+doc/libzeitgeist/docs_vala
diff --git a/data/ontology2code b/data/ontology2code
index 9148c4d0..988e711a 100755
--- a/data/ontology2code
+++ b/data/ontology2code
@@ -285,9 +285,10 @@ class ValaSerializer(GenericSerializer):
 		doc = symbol.doc
 
 		# List children
-		children = ['#' + cls.symbol_link(child) for child in symbol.children]
+		children = [cls.symbol_link(child) for child in symbol.children]
 		if children:
-			doc += '\n\n Children: %s' % ', '.join(children)
+			doc += '\n\n Children: %s' % ', '.join('{@link %s}' % child
+				for child in children)
 		else:
 			doc += '\n\n Children: None'
 
diff --git a/libzeitgeist/enumerations.vala b/libzeitgeist/enumerations.vala
index d735e199..54c20178 100644
--- a/libzeitgeist/enumerations.vala
+++ b/libzeitgeist/enumerations.vala
@@ -162,8 +162,12 @@ public enum ResultType
                                                // ordered ascendingly by
                                                // the popularity of the
                                                // origin
-    RELEVANCY                           = 100;
-      /*
+    RELEVANCY                            = 100;//   Only allowed on
+                                               // zeitgeist_index_search().
+                                               // Events are sorted by query
+                                               // relevancy
+
+     /*
      * Returns true if the results for the given result_type will be sorted
      * ascendantly by date, false if they'll be sorted descendingly.
      **/
@@ -209,6 +213,7 @@ public enum ResultType
             case ResultType.MOST_POPULAR_SUBJECT_INTERPRETATION:
             case ResultType.MOST_RECENT_MIMETYPE:
             case ResultType.MOST_POPULAR_MIMETYPE:
+            case ResultType.RELEVANCY:
                 return false;
 
             default:
diff --git a/libzeitgeist/event.vala b/libzeitgeist/event.vala
index 9112c3d7..4557eac4 100644
--- a/libzeitgeist/event.vala
+++ b/libzeitgeist/event.vala
@@ -72,12 +72,12 @@ private bool check_field_match (string? property,
 }
 
 /**
- * #Event objects abstract Zeitgeist events
+ * Event objects abstract Zeitgeist events
  *
- * The #Event class is one of the primary elements for communicating
- * with the Zeitgeist daemon. #Events serve two purposes
+ * The Event class is one of the primary elements for communicating
+ * with the Zeitgeist daemon. Events serve two purposes
  * Unsurprisingly, they represent events that have happened, but they
- * can also act as templates. See also #Subject.
+ * can also act as templates. See also {@link Subject}.
  *
  * An event in the Zeitgeist world is characterized by two main
  * properties. "What happened", also called the interpretation, and
diff --git a/libzeitgeist/index.vala b/libzeitgeist/index.vala
index 0c3d669d..9878d11d 100644
--- a/libzeitgeist/index.vala
+++ b/libzeitgeist/index.vala
@@ -37,7 +37,7 @@ public class Index : QueuedProxyWrapper
      * Create a new index that interfaces with the default event index of the
      * Zeitgeist daemon.
      *
-     * Create a new #ZeitgeistIndex instance. The index will start to connect
+     * Create a new {@link Index} instance. The index will start to connect
      * to Zeitgeist asynchronously. You can however start calling methods on
      * the returned instance immediately, any method calls issued before the
      * connection has been established will simply be queued and executed once
@@ -73,7 +73,7 @@ public class Index : QueuedProxyWrapper
     }
 
     /**
-     * Perform a full text search possibly restricted to a #ZeitgeistTimeRange
+     * Perform a full text search possibly restricted to a {@link TimeRange}
      * and/or set of event templates.
      *
      * The default boolean operator is %AND. Thus the query
@@ -110,11 +110,12 @@ public class Index : QueuedProxyWrapper
      *     templates
      * @param offset Offset into the result set to read events from
      * @param num_events Maximal number of events to retrieve
-     * @param result_type The #ZeitgeistResultType determining the sort order.
-     *     You may pass #ZEITGEIST_RESULT_TYPE_RELEVANCY to this
+     * @param result_type The {@link ResultType} determining the sort order.
+     *     You may pass {@link ResultType.RELEVANCY} to this
      *     method to have the results ordered by relevancy calculated
      *     in relation to @query
-     * @param cancellable A #GCancellable used to cancel the call or %NULL
+     * @param cancellable A {@link GLib.Cancellable} used to cancel the
+     *     call or %NULL
      */
     public async ResultSet search (
         string query,
@@ -139,10 +140,10 @@ public class Index : QueuedProxyWrapper
     }
 
     /**
-     * Perform a full text search possibly restricted to a #ZeitgeistTimeRange
+     * Perform a full text search possibly restricted to a {@link TimeRange}
      * and/or set of event templates. As opposed to zeitgeist_index_search(),
      * this call will also return numeric relevancies of the events
-     * in the #ZeitgeistResultSet.
+     * in the {@link ResultSet}.
      *
      * See zeitgeist_index_search() for more details on how to create the
      * query.
@@ -158,11 +159,11 @@ public class Index : QueuedProxyWrapper
      *     medium.
      * @param offset Offset into the result set to read events from
      * @param num_events Maximal number of events to retrieve
-     * @param result_type The #ZeitgeistResultType determining the sort order
-     *     You may pass #ZEITGEIST_RESULT_TYPE_RELEVANCY to this method to
+     * @param result_type The {@link ResultType} determining the sort order
+     *     You may pass {@link ResultType.RELEVANCY} to this method to
      *     have the results ordered by relevancy calculated in relation
      *     to "query"
-     * @param cancellable A #GCancellable used to cancel the call or %NULL
+     * @param cancellable A {@link Cancellable} used to cancel the call or %NULL
      */
     public async ResultSet search_with_relevancies (
         string query,
diff --git a/libzeitgeist/mimetype.vala b/libzeitgeist/mimetype.vala
index 21291476..e6abc7b5 100644
--- a/libzeitgeist/mimetype.vala
+++ b/libzeitgeist/mimetype.vala
@@ -22,13 +22,13 @@
 
 using Zeitgeist;
 
-/**
- * Mime-Type mapping and URI comprehension
- */
-
 namespace Zeitgeist
 {
 
+    /**
+     * Mime-Type mapping and URI comprehension
+     */
+
     private static bool mimetypes_loaded = false;
     private static bool schemes_loaded = false;
 
@@ -79,8 +79,6 @@ namespace Zeitgeist
      * unless you have very specific needs you will normally not have to call
      * this function.
      *
-     * FIXME: link to list of interpretations
-     *
      * @param mimetype  A MIME-type string. Eg. //text/plain//
      * @param interpretation_uri A URI defining the subject interpretation
      *     type to associate with "mimetype"
@@ -110,8 +108,6 @@ namespace Zeitgeist
      * unless you have very specific needs you will normally not have to call
      * this function.
      *
-     * FIXME: link to list of interpretations
-     *
      * @param mimetype_regex A regular expression matching a certain range of
      *     mimetypes. Eg. //text/.* // to match all //text// subtypes.
      * @param interpretation_uri A URI defining the subject interpretation
@@ -133,7 +129,6 @@ namespace Zeitgeist
      * zeitgeist_interpretation_for_mimetype:
      *
      * Look up the subject interpretation type associated with @mimetype.
-     * FIXME: link to list of interpretations
      *
      * @param mimetype A MIME-type string. Eg. //text/plain//
      *
@@ -171,8 +166,6 @@ namespace Zeitgeist
      * you have very specific needs you will normally not have to call this
      * function.
      *
-     * FIXME: link to list of manifestations
-     *
      * @param uri_scheme A URI scheme such as //http:\/\///
      * @param manifestation_type A URI defining the subject manifestation type
      *     to associate with "uri_scheme"
@@ -191,8 +184,6 @@ namespace Zeitgeist
      * //file:\/\/\/tmp/foo.txt// you will get back
      * ZEITGEIST_NFO_FILE_DATA_OBJECT.
      *
-     * FIXME: link to list of manifestations
-     *
      * @param uri An URI
      *
      * @return A subject manifestation type for @uri or %NULL in case no
diff --git a/libzeitgeist/timestamp.vala b/libzeitgeist/timestamp.vala
index 30aeadd2..039ac45d 100644
--- a/libzeitgeist/timestamp.vala
+++ b/libzeitgeist/timestamp.vala
@@ -67,7 +67,8 @@ namespace Zeitgeist.Timestamp
     public const int64 YEAR = 31556952000;
 
     /**
-     * Convert a #GTimeVal to the amount of milliseconds since the Unix Epoch
+     * Convert a {@link GLib.TimeVal} to an amount of milliseconds since
+     * the Unix Epoch
      *
      * @param timeval time to convert
      *
@@ -80,14 +81,14 @@ namespace Zeitgeist.Timestamp
     }
 
     /**
-     * Write a Zeitgeist timestamp to a #GTimeVal instance. Note that Zeitgeist
-     * uses only a millisecond resolution for where #GTimeVal uses a microsecond
-     * resolution, meaning that the lower three digits of @tv.tv_usec will
-     * be 0.
+     * Write a Zeitgeist timestamp to a {@link GLib.TimeVal} instance.
+     * Note that Zeitgeist uses only a millisecond resolution, whereas
+     * {@link GLib.TimeVal} has microsecond resolution. This means that
+     * the lower three digits of @tv.tv_usec will always be 0.
      *
      * @param timestamp to convert
      *
-     * @return the equivalent #GTimeVal instance.
+     * @return the equivalent {@link GLib.TimeVal} instance.
      */
     public TimeVal to_timeval (int64 timestamp)
     {
@@ -173,10 +174,10 @@ namespace Zeitgeist.Timestamp
     }
 
     /**
-     * Write a timestamp to a #GDate structure
+     * Write a timestamp to a {@link GLib.Date} structure
      *
      * @param timestamp to convert
-     * @return #GDate initialized to the given timestamp
+     * @return {@link GLib.Date} initialized to the given timestamp
      */
     public Date to_date (int64 timestamp)
     {