From d7fd31be838a33e3a55717f80be850b7db55746d Mon Sep 17 00:00:00 2001
From: Andre Noll <maan@congo.fml.local>
Date: Tue, 19 Sep 2006 13:42:32 +0200
Subject: [PATCH] add documentation for struct osx_buffer

---
 osx_write.c | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/osx_write.c b/osx_write.c
index b3049c5a..4d0bfbdf 100644
--- 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;
 };
 
-- 
2.39.5