music_pipe: document struct music_chunk

Add doxygen compatible comments.

1 files changed, 11 insertions, 0 deletions

diff --git a/src/pipe.h b/src/pipe.h
index 4d57adc04..7d2912197 100644
--- a/src/pipe.h
+++ b/src/pipe.h
@@ -28,10 +28,21 @@
 
 struct audio_format;
 
+/**
+ * A chunk of music data.  Its format is defined by the
+ * music_pipe_append() caller.
+ */
 struct music_chunk {
+	/** number of bytes stored in this chunk */
 	uint16_t length;
+
+	/** current bit rate of the source file */
 	uint16_t bit_rate;
+
+	/** the time stamp within the song */
 	float times;
+
+	/** the data (probably PCM) */
 	char data[CHUNK_SIZE];
 };