From: Andre Noll <maan@systemlinux.org>
Date: Sun, 3 Jun 2007 21:58:44 +0000 (+0200)
Subject: ogg_afh.c: add documentation of struct ogg_datasource
X-Git-Tag: v0.2.17~58^2~2
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=33713473b1051c2d9f487c66a92a5cbdf1277ce3

ogg_afh.c: add documentation of struct ogg_datasource
---

diff --git a/ogg_afh.c b/ogg_afh.c
index d5c47262..6a66b8e3 100644
--- a/ogg_afh.c
+++ b/ogg_afh.c
@@ -30,9 +30,13 @@
 #define CHUNK_SIZE 32768
 static double chunk_time = 0.25;
 
+/** describes a memory-mapped ogg vorbis file */
 struct ogg_datasource {
+	/** the memory mapping */
 	char *map;
+	/** this size of the mapping */
 	off_t numbytes;
+	/** the current position in the mapping */
 	off_t fpos;
 };