From: Richard Kettlewell <rjk@greenend.org.uk>
Date: Sat, 14 Mar 2009 20:59:50 +0000 (+0000)
Subject: A little doxygen tidy-up
X-Git-Tag: 5.0~166
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/commitdiff_plain/8d251217b5cfeae9d277054a456c4064eabde569?hp=7cd4dd21e8fc01abacf50118ca70797f5875b92b

A little doxygen tidy-up
---

diff --git a/clients/playrtp.c b/clients/playrtp.c
index 338cbbf..c6f0ad9 100644
--- a/clients/playrtp.c
+++ b/clients/playrtp.c
@@ -24,20 +24,20 @@
  * systems.  There is no support for Microsoft Windows yet, and that will in
  * fact probably an entirely separate program.
  *
- * The program runs (at least) three threads.  listen_thread() is responsible
- * for reading RTP packets off the wire and adding them to the linked list @ref
- * received_packets, assuming they are basically sound.  queue_thread() takes
- * packets off this linked list and adds them to @ref packets (an operation
- * which might be much slower due to contention for @ref lock).
- *
- * The main thread is responsible for actually playing audio.  In ALSA this
- * means it waits until ALSA says it's ready for more audio which it then
- * plays.  See @ref clients/playrtp-alsa.c.
- *
- * In Core Audio the main thread is only responsible for starting and stopping
- * play: the system does the actual playback in its own private thread, and
- * calls adioproc() to fetch the audio data.  See @ref
- * clients/playrtp-coreaudio.c.
+ * The program runs (at least) three threads:
+ *
+ * listen_thread() is responsible for reading RTP packets off the wire and
+ * adding them to the linked list @ref received_packets, assuming they are
+ * basically sound.
+ *
+ * queue_thread() takes packets off this linked list and adds them to @ref
+ * packets (an operation which might be much slower due to contention for @ref
+ * lock).
+ *
+ * control_thread() accepts commands from Disobedience (or anything else).
+ *
+ * The main thread activates and deactivates audio playing via the @ref
+ * lib/uaudio.h API (which probably implies at least one further thread).
  *
  * Sometimes it happens that there is no audio available to play.  This may
  * because the server went away, or a packet was dropped, or the server
diff --git a/lib/coreaudio.c b/lib/coreaudio.c
index f6a8162..8540faa 100644
--- a/lib/coreaudio.c
+++ b/lib/coreaudio.c
@@ -16,7 +16,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 /** @file lib/coreaudio.c
- * @brief Support for @ref BACKEND_COREAUDIO
+ * @brief Support for Apple Core Audio
  */
 
 #include "common.h"
@@ -65,9 +65,9 @@ static AudioDeviceID coreaudio_use_default(void) {
 
 /** @brief Find a device by some string
  * @param selector Selector for property to look for
- * @param description Property description
  * @param devs List of device IDs
  * @param ndevs Number of device IDs in @p devs
+ * @param dev Desired device name
  * @param resultp Where to put device ID
  * @return 1 if found, 0 if not found
  */
diff --git a/lib/coreaudio.h b/lib/coreaudio.h
index dee24bb..706f609 100644
--- a/lib/coreaudio.h
+++ b/lib/coreaudio.h
@@ -16,7 +16,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 /** @file lib/coreaudio.h
- * @brief Support for @ref BACKEND_COREAUDIO
+ * @brief Support for Apple Core Audio
  */
 
 #ifndef COREAUDIO_H
diff --git a/lib/uaudio-thread.c b/lib/uaudio-thread.c
index 6bed4a8..30a3b8a 100644
--- a/lib/uaudio-thread.c
+++ b/lib/uaudio-thread.c
@@ -198,11 +198,15 @@ static void *uaudio_play_thread_fn(void attribute((unused)) *arg) {
  * @param playcallback Callback to play audio data
  * @param min Minimum number of samples to play in a chunk
  * @param max Maximum number of samples to play in a chunk
+ * @param flags Flags
  *
  * @p callback will be called multiple times in quick succession if necessary
  * to gather at least @p min samples.  Equally @p playcallback may be called
  * repeatedly in quick succession to play however much was received in a single
  * chunk.
+ *
+ * Possible flags are:
+ * - @ref UAUDIO_THREAD_FAKE_PAUSE
  */
 void uaudio_thread_start(uaudio_callback *callback,
 			 void *userdata,