update comment

git-svn-id: file:///home/lennart/svn/public/libcanberra/trunk@51 01b60673-d06a-42c0-afdd-89cb8e0f78ac

1 files changed, 7 insertions, 4 deletions

diff --git a/src/canberra.h b/src/canberra.h
index 5bc47c9..86e83a9 100644
--- a/src/canberra.h
+++ b/src/canberra.h
@@ -124,10 +124,13 @@
 /* Context object */
 typedef struct ca_context ca_context;
 
-/** Playback completion event callback. This callback will be called
- * from a background thread. The code implementing this function may
- * not call any libcanberra API call from this callback -- this might
- * result in a deadlock. */
+/** Playback completion event callback. The context this callback is
+ * called in is undefined, it might or might not be called from a
+ * background thread, and from any strackframe. The code implementing
+ * this function may not call any libcanberra API call from this
+ * callback -- this might result in a deadlock. Instead it may only be
+ * used to asynchronously signal some kind of notification object
+ * (semaphore, message queue, ...). */
 typedef void (*ca_finish_callback_t)(ca_context *c, uint32_t id, int error_code, void *userdata);
 
 /** Error codes */