[FFmpeg-cvslog] r18100 - trunk/libavformat/oggdec.h

[conrad]

Author: conrad
Date: Sat Mar 21 09:03:30 2009
New Revision: 18100

Log:
Document ogg_codec's header function

Modified:
   trunk/libavformat/oggdec.h

Modified: trunk/libavformat/oggdec.h
==============================================================================
--- trunk/libavformat/oggdec.h	Sat Mar 21 08:36:25 2009	(r18099)
+++ trunk/libavformat/oggdec.h	Sat Mar 21 09:03:30 2009	(r18100)
@@ -31,6 +31,12 @@ struct ogg_codec {
     const int8_t *magic;
     uint8_t magicsize;
     const int8_t *name;
+    /**
+     * Attempt to process a packet as a header
+     * @return 1 if the packet was a valid header,
+     *         0 if the packet was not a header (was a data packet)
+     *         -1 if an error occurred or for unsupported stream
+     */
     int (*header)(AVFormatContext *, int);
     int (*packet)(AVFormatContext *, int);
     uint64_t (*gptopts)(AVFormatContext *, int, uint64_t);