avcodec/codec: add doxy to AVCodec.decode()

Signed-off-by: James Almer <jamrial@gmail.com>

diff --git a/libavcodec/codec.h b/libavcodec/codec.h
index f96372f77a7426f71c276fc602ca6a9e0b9efcbe..0ab618d71cd40096e9ce80c8d95065943b1357d5 100644 (file)
--- a/libavcodec/codec.h
+++ b/libavcodec/codec.h
@@ -281,6 +281,18 @@ 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_frame_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 data to be decoded
+     * @return amount of bytes read from the packet on success, negative error
+     *         code on failure
+     */
     int (*decode)(struct AVCodecContext *avctx, void *outdata,
                   int *got_frame_ptr, struct AVPacket *avpkt);
     int (*close)(struct AVCodecContext *);