[FFmpeg-devel] [PATCH 3/3] avcodec/codec: add doxy to AVCodec.decode()

[James Almer]

Signed-off-by: James Almer <jamrial at gmail.com>
---
 libavcodec/codec.h | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/libavcodec/codec.h b/libavcodec/codec.h
index bcda061da1..c019e7357c 100644
--- a/libavcodec/codec.h
+++ b/libavcodec/codec.h
@@ -281,6 +281,17 @@ typedef struct AVCodec {
      */
     int (*encode2)(struct AVCodecContext *avctx, struct AVPacket *avpkt,
                    const struct AVFrame *frame, int *got_packet_ptr);
+    /**
+     * Decode picture or subtitle data.
+     *
+     * @param      avctx          codec context
+     * @param      outdata        codec type dependent output struct
+     * @param[out] got_packet_ptr decoder sets to 0 or 1 to indicate that a
+     *                            non-empty frame or subtitle was returned in
+     *                            outdata.
+     * @param[in]  avpkt          AVPacket containing the bitstream to be decoded
+     * @return amount of bytes read from the packet, negative error code on failure
+     */
     int (*decode)(struct AVCodecContext *, void *outdata, int *got_frame_ptr,
                   struct AVPacket *avpkt);
     int (*close)(struct AVCodecContext *);
-- 
2.30.1