add documentation for struct osx_buffer
authorAndre Noll <maan@congo.fml.local>
Tue, 19 Sep 2006 11:42:32 +0000 (13:42 +0200)
committerAndre Noll <maan@congo.fml.local>
Tue, 19 Sep 2006 11:42:32 +0000 (13:42 +0200)
osx_write.c

index b3049c5..4d0bfbd 100644 (file)
 #include <CoreAudio/CoreAudio.h>
 #include <AudioUnit/AudioUnit.h>
 #include <AudioToolbox/DefaultAudioOutput.h>
 #include <CoreAudio/CoreAudio.h>
 #include <AudioUnit/AudioUnit.h>
 #include <AudioToolbox/DefaultAudioOutput.h>
+
+/** describes one input buffer for the osx writer */
 struct osx_buffer {
 struct osx_buffer {
+       /** pointer to the beginning of the buffer */
        float *buffer;
        float *buffer;
+       /** the size of this buffer */
        long size;
        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;
        long remaining;
+       /** pointer to the next audio buffer */
        struct osx_buffer *next;
 };
 
        struct osx_buffer *next;
 };