add documentation for struct osx_buffer

diff --git a/osx_write.c b/osx_write.c
index b3049c5aadf375abd365e49dafc8a26ff123bd91..4d0bfbdf4f4f9aa300364aa3d53dcee40bb8ba14 100644 (file)
--- a/osx_write.c
+++ b/osx_write.c
@@ -37,11 +37,18 @@
 #include <CoreAudio/CoreAudio.h>
 #include <AudioUnit/AudioUnit.h>
 #include <AudioToolbox/DefaultAudioOutput.h>
+
+/** describes one input buffer for the osx writer */
 struct osx_buffer {
+       /** pointer to the beginning of the buffer */
        float *buffer;
+       /** the size of this buffer */
        long size;
-       float *ptr; /* Where in the buffer are we? */
+       /* current position in the buffer */
+       float *ptr;
+       /** number of floats not yet consuned */
        long remaining;
+       /** pointer to the next audio buffer */
        struct osx_buffer *next;
 };