Document ogg_codec's header function

Originally committed as revision 18100 to svn://svn.ffmpeg.org/ffmpeg/trunk

diff --git a/libavformat/oggdec.h b/libavformat/oggdec.h
index d238e99a4b047d9becd76f91c205b3a3672943a7..1d65ba7979d493b1885557cc1a095bdf87ff5d1e 100644 (file)
--- a/libavformat/oggdec.h
+++ b/libavformat/oggdec.h
@@ -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);