Documentation for waitop function

git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@25411 b3059339-0415-0410-9bf9-f77b7e298cf2

1 files changed, 6 insertions, 0 deletions

diff --git a/libao2/ao_pulse.c b/libao2/ao_pulse.c
index 97c0c8398e..3ba7214e26 100644
--- a/libao2/ao_pulse.c
+++ b/libao2/ao_pulse.c
@@ -91,6 +91,12 @@ static void success_cb(pa_stream *s, int success, void *userdata) {
     pa_threaded_mainloop_signal(mainloop, 0);
 }
 
+/**
+ * \brief waits for a pulseaudio operation to finish, frees it and
+ *        unlocks the mainloop
+ * \param op operation to wait for
+ * \return 1 if operation has finished normally (DONE state), 0 otherwise
+ */
 static int waitop(pa_operation *op) {
     pa_operation_state_t state;
     if (!op) return 0;