From a1edc199dfc3981ca921fc56d390dac46f6b74ff Mon Sep 17 00:00:00 2001 From: Max Kellermann Date: Mon, 10 Jan 2011 22:16:44 +0100 Subject: [PATCH] output_control: document internal functions --- src/output_control.c | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/output_control.c b/src/output_control.c index 2c0e113ec..2bbeb3f81 100644 --- a/src/output_control.c +++ b/src/output_control.c @@ -38,6 +38,11 @@ enum { struct notify audio_output_client_notify; +/** + * Waits for command completion. + * + * @param ao the #audio_output instance; must be locked + */ static void ao_command_wait(struct audio_output *ao) { while (ao->command != AO_COMMAND_NONE) { @@ -47,6 +52,12 @@ static void ao_command_wait(struct audio_output *ao) } } +/** + * Sends a command to the #audio_output object, but does not wait for + * completion. + * + * @param ao the #audio_output instance; must be locked + */ static void ao_command_async(struct audio_output *ao, enum audio_output_command cmd) { @@ -55,6 +66,12 @@ static void ao_command_async(struct audio_output *ao, g_cond_signal(ao->cond); } +/** + * Sends a command to the #audio_output object and waits for + * completion. + * + * @param ao the #audio_output instance; must be locked + */ static void ao_command(struct audio_output *ao, enum audio_output_command cmd) {