ogg_afh.c: add documentation of struct ogg_datasource
authorAndre Noll <maan@systemlinux.org>
Sun, 3 Jun 2007 21:58:44 +0000 (23:58 +0200)
committerAndre Noll <maan@systemlinux.org>
Sun, 3 Jun 2007 21:58:44 +0000 (23:58 +0200)
ogg_afh.c

index d5c4726..6a66b8e 100644 (file)
--- a/ogg_afh.c
+++ b/ogg_afh.c
 #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;
 };