[grilo] Comment grl_multiple_cancel() function



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

    Comment grl_multiple_cancel() function

 src/grl-multiple.c |   14 +++++++++++++-
 1 files changed, 13 insertions(+), 1 deletions(-)
---
diff --git a/src/grl-multiple.c b/src/grl-multiple.c
index 38d29e6..7bacfbf 100644
--- a/src/grl-multiple.c
+++ b/src/grl-multiple.c
@@ -478,11 +478,23 @@ grl_multiple_search (const GList *sources,
   return msd->search_id;
 }
 
+/**
+ * grl_multiple_cancel:
+ * @operation_id: the identifier of the running operation
+ *
+ * Cancel a running method.
+ *
+ * Every method has a operation identifier, which is set as parameter in the
+ * callback. The running operation can be cancel then.
+ *
+ * The derived class must implement the cancel vmethod in order to
+ * honor the request.
+ */
 void
 grl_multiple_cancel (guint search_id)
 {
   g_debug ("grl_multiple_cancel");
-  
+
   struct MultipleSearchData *msd;
   GList *sources, *ids;
 



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