ogg_afh.c: add documentation of struct ogg_datasource

[paraslash.git] / ogg_afh.c

diff --git a/ogg_afh.c b/ogg_afh.c
index d5c4726..6a66b8e 100644 (file)
--- a/ogg_afh.c
+++ b/ogg_afh.c
@@ -30,9 +30,13 @@
 #define CHUNK_SIZE 32768
 static double chunk_time = 0.25;
 
 #define CHUNK_SIZE 32768
 static double chunk_time = 0.25;
 

+/** describes a memory-mapped ogg vorbis file */

 struct ogg_datasource {
 struct ogg_datasource {

+       /** the memory mapping */

        char *map;
        char *map;

+       /** this size of the mapping */

        off_t numbytes;
        off_t numbytes;

+       /** the current position in the mapping */

        off_t fpos;
 };
 
        off_t fpos;
 };