diff options
author | Seif Lotfy <seif@lotfy.com> | 2013-01-18 11:31:38 +0100 |
---|---|---|
committer | Seif Lotfy <seif@lotfy.com> | 2013-01-18 11:31:38 +0100 |
commit | c3b3f7608b8cb9c10a4b54b5d6f5369fb72390cb (patch) | |
tree | 1b726a614f631a42bbc015b68858bdfc9cc77cc6 | |
parent | 98a17f4b92ee4d2dcb3bc6ebf016fd487167c3d0 (diff) | |
download | zeitgeist-c3b3f7608b8cb9c10a4b54b5d6f5369fb72390cb.tar.gz |
Fix documentation warnings
-rw-r--r-- | libzeitgeist/index.vala | 2 | ||||
-rw-r--r-- | libzeitgeist/log.vala | 35 | ||||
-rw-r--r-- | libzeitgeist/timerange.vala | 3 |
3 files changed, 21 insertions, 19 deletions
diff --git a/libzeitgeist/index.vala b/libzeitgeist/index.vala index 9878d11d..6ab3d716 100644 --- a/libzeitgeist/index.vala +++ b/libzeitgeist/index.vala @@ -163,7 +163,7 @@ public class Index : QueuedProxyWrapper * You may pass {@link ResultType.RELEVANCY} to this method to * have the results ordered by relevancy calculated in relation * to "query" - * @param cancellable A {@link Cancellable} used to cancel the call or %NULL + * @param cancellable a {@link GLib.Cancellable} to cancel the operation or %NULL */ public async ResultSet search_with_relevancies ( string query, diff --git a/libzeitgeist/log.vala b/libzeitgeist/log.vala index 6fda5aee..a0db8712 100644 --- a/libzeitgeist/log.vala +++ b/libzeitgeist/log.vala @@ -119,7 +119,7 @@ public class Log : QueuedProxyWrapper * be inserted into the log. * * @param event A {@link Event} - * @param cancellable:To cancel the operation or NULL + * @param cancellable a {@link GLib.Cancellable} to cancel the operation or %NULL */ public async Array<uint32> insert_event (Event event, Cancellable? cancellable=null) throws Error @@ -134,8 +134,8 @@ public class Log : QueuedProxyWrapper * Asynchronously send a set of events to the Zeitgeist daemon, requesting they * be inserted into the log. * - * @param events An {@link GenericArray} of {@link Event} - * @param cancellable To cancel the operation or NULL + * @param events An {@link GLib.GenericArray} of {@link Event} + * @param cancellable a {@link GLib.Cancellable} to cancel the operation or %NULL */ public async Array<uint32> insert_events (GenericArray<Event> events, Cancellable? cancellable=null) throws Error @@ -179,7 +179,7 @@ public class Log : QueuedProxyWrapper * This method is exactly equivalent to calling zeitgeist_log_insert_event() * with NULL set as @cancellable, @callback, and @user_data. * - * @param events An {@link GenericArray} of {@link Event} + * @param events An {@link GLib.GenericArray} of {@link Event} */ public async void insert_events_no_reply (GenericArray<Event> events) throws Error @@ -199,17 +199,17 @@ public class Log : QueuedProxyWrapper * * If you need to do a query yielding a large (or unpredictable) result set * and you only want to show some of the results at the same time (eg., by - * paging them), consider using {@link find_event_ids_for_templates}. + * paging them), consider using {@link find_event_ids}. * * In order to use this method there needs to be a mainloop runnning. * Both Qt and GLib mainloops are supported. * * @param time_range {@link TimeRange} A time range in which the events should be considered in * @param storage_state {@link StorageState} storage state - * @param event_templates An {@link GenericArray} of {@link Event} + * @param event_templates An {@link GLib.GenericArray} of {@link Event} * @param num_events int represteing the number of events that should be returned * @param result_type {@link ResultType} how the events should be grouped and sorted - * @param cancellable To cancel the operation or NULL + * @param cancellable a {@link GLib.Cancellable} to cancel the operation or %NULL */ public async ResultSet find_events ( TimeRange time_range, @@ -246,10 +246,10 @@ public class Log : QueuedProxyWrapper * * @param time_range {@link TimeRange} A time range in which the events should be considered in * @param storage_state {@link StorageState} storage state - * @param event_templates An {@link GenericArray} of {@link Event} + * @param event_templates An {@link GLib.GenericArray} of {@link Event} * @param num_events int represteing the number of events that should be returned * @param result_type {@link ResultType} how the events should be grouped and sorted - * @param cancellable To cancel the operation or NULL + * @param cancellable a {@link GLib.Cancellable} to cancel the operation or %NULL */ public async uint32[] find_event_ids ( TimeRange time_range, @@ -273,7 +273,7 @@ public class Log : QueuedProxyWrapper * of event ids. This is useful for looking up the event data for events found * with the find_event_ids_* family of functions. * - * Each {@link Evnet} which is not found in the {@link Log} is represented by + * Each {@link Event} which is not found in the {@link Log} is represented by * NULL in the resulting collection. The query will be done via an asynchronous * DBus call and this method will return immediately. The returned events will * be passed to callback as a list of {@link Event}s, which must be the only @@ -281,8 +281,8 @@ public class Log : QueuedProxyWrapper * * In order to use this method there needs to be a mainloop runnning. * - * @param Array<int> {@link Event} ids - * @param cancellable To cancel the operation or NULL + * @param event_ids a {@link GLib.Array} of {@link Event} ids + * @param cancellable a {@link GLib.Cancellable} to cancel the operation or %NULL */ public async ResultSet get_events ( Array<uint32> event_ids, @@ -305,11 +305,11 @@ public class Log : QueuedProxyWrapper * * @param time_range {@link TimeRange} A time range in which the events should be considered in * @param storage_state {@link StorageState} storage state - * @param event_templates An {@link GenericArray} of {@link Event} describing the events to relate to - * @param result_templates An {@link GenericArray} of {@link Event} desrcibing the result to be returned + * @param event_templates An {@link GLib.GenericArray} of {@link Event} describing the events to relate to + * @param result_event_templates An {@link GLib.GenericArray} of {@link Event} desrcibing the result to be returned * @param num_events int represteing the number of events that should be returned * @param result_type {@link ResultType} how the events should be grouped and sorted - * @param cancellable To cancel the operation or NULL + * @param cancellable a {@link GLib.Cancellable} to cancel the operation or %NULL */ public async string[] find_related_uris ( TimeRange time_range, @@ -342,6 +342,7 @@ public class Log : QueuedProxyWrapper * The deletion will be done asynchronously, and this method returns immediately. * * @param event_ids Array<uint32> + * @param cancellable a {@link GLib.Cancellable} to cancel the operation or %NULL */ public async TimeRange delete_events (Array<uint32> event_ids, Cancellable? cancellable=null) throws Error @@ -353,7 +354,9 @@ public class Log : QueuedProxyWrapper Variant time_range = yield proxy.delete_events (_ids, cancellable); return new TimeRange.from_variant(time_range); } - + /** + * @param cancellable a {@link GLib.Cancellable} to cancel the operation or %NULL + */ public async void quit (Cancellable? cancellable=null) throws Error { yield wait_for_proxy (); diff --git a/libzeitgeist/timerange.vala b/libzeitgeist/timerange.vala index 4b0a6c54..b96d1e29 100644 --- a/libzeitgeist/timerange.vala +++ b/libzeitgeist/timerange.vala @@ -45,7 +45,7 @@ public class TimeRange: Object * since the Unix Epoch * @param end_msec ending timestamp in number of milliseconds * since the Unix Epoch - * @param a newly allocated ZeitgeistTimeRange. Free with + * @return a newly allocated ZeitgeistTimeRange. Free with * g_object_unref() */ public TimeRange (int64 start_msec, int64 end_msec) @@ -103,7 +103,6 @@ public class TimeRange: Object } /** - * @param a #TimeRange * @return a new variant holding the time range */ public Variant to_variant () |