[FFmpeg-cvslog] libavformat/oggdec.h: Change paket function documentation to return 1 on header packets only.

[Romain Beauxis]

ffmpeg | branch: master | Romain Beauxis <romain.beauxis at gmail.com> | Sat May 24 13:14:08 2025 -0500| [5030564376ea3ab76ffcfdd0a1a3f3c5e263bc99] | committer: Michael Niedermayer

libavformat/oggdec.h: Change paket function documentation to return 1 on header packets only.

Signed-off-by: Michael Niedermayer <michael at niedermayer.cc>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=5030564376ea3ab76ffcfdd0a1a3f3c5e263bc99
---

 libavformat/oggdec.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/libavformat/oggdec.h b/libavformat/oggdec.h
index 5083de646c..c15fbe738e 100644
--- a/libavformat/oggdec.h
+++ b/libavformat/oggdec.h
@@ -42,8 +42,8 @@ struct ogg_codec {
      * Attempt to process a packet as a data packet
      * @return < 0 (AVERROR) code or -1 on error
      *         == 0 if the packet was a regular data packet.
-     *         == 0 or 1 if the packet was a header from a chained bitstream.
-     *           (1 will cause the packet to be skiped in calling code (ogg_packet())
+     *         == 1 if the packet was a header from a chained bitstream.
+     *            This will cause the packet to be skiped in calling code (ogg_packet()
      */
     int (*packet)(AVFormatContext *, int);
     /**