# HG changeset patch
# User conrad
# Date 1237622610 0
# Node ID c6abeafbec3078bf45c97c6cdc540a4d1c4c6461
# Parent  e69e94c9d3e220431cfdbf06076ef7d5a75d6b39
Document ogg_codec's header function

diff -r e69e94c9d3e2 -r c6abeafbec30 oggdec.h
--- a/oggdec.h	Sat Mar 21 07:36:25 2009 +0000
+++ b/oggdec.h	Sat Mar 21 08:03:30 2009 +0000
@@ -31,6 +31,12 @@
     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);