[grilo] Comment grl_multiple_search() function



commit da41c19bf714f37df4d40db068f81fa870e0c253
Author: Juan A. Suarez Romero <jasuarez igalia com>
Date:   Thu Jul 8 11:18:12 2010 +0200

    Comment grl_multiple_search() function

 src/grl-multiple.c |   17 +++++++++++++++++
 1 files changed, 17 insertions(+), 0 deletions(-)
---
diff --git a/src/grl-multiple.c b/src/grl-multiple.c
index 31fa6f8..38d29e6 100644
--- a/src/grl-multiple.c
+++ b/src/grl-multiple.c
@@ -394,6 +394,23 @@ multiple_search_cb (GrlMediaSource *source,
 
 /* ================ API ================ */
 
+/**
+ * grl_multiple_search:
+ * @sources: a list of sources where to search
+ * @text: the text to search
+ * @keys: the list of #GrlKeyID to request
+ * @count: the number of elements to retrieve in the operation
+ * @flags: the resolution mode
+ * @callback: the user defined callback
+ * @user_data: the user data to pass in the callback
+ *
+ * Search for the @text string in a list of sources for data identified with
+ * that string.
+ *
+ * This method is asynchronous.
+ *
+ * Returns: the operation identifier
+ */
 guint
 grl_multiple_search (const GList *sources,
 		     const gchar *text,



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]