client: extend documentation on pa_operation_cancel() a bit

diff --git a/src/pulse/operation.h b/src/pulse/operation.h
index 7b0dabdd12e2ede6bda43542a3b4d7e12548aca3..b6b5691d2bff1a74efa1c7203ad1a9465e79b022 100644 (file)
--- a/src/pulse/operation.h
+++ b/src/pulse/operation.h
@@ -40,7 +40,11 @@ pa_operation *pa_operation_ref(pa_operation *o);
 /** Decrease the reference count by one */
 void pa_operation_unref(pa_operation *o);
 
-/** Cancel the operation. Beware! This will not necessarily cancel the execution of the operation on the server side. */
+/** Cancel the operation. Beware! This will not necessarily cancel the
+ * execution of the operation on the server side. However it will make
+ * sure that the callback associated with this operation will not be
+ * called anymore, effectively disabling the operation from the client
+ * side's view. */
 void pa_operation_cancel(pa_operation *o);
 
 /** Return the current status of the operation */