[FFmpeg-devel] [PATCH] avcodec: fix some docstrings

Nicolas Granger nicolas.granger.m at gmail.com
Sun Jan 13 01:15:55 EET 2019


Hello,

This fixes an erroneous reference and missing links in the API documentation.

Best regards,

Nicolas Granger

---
libavcodec/avcodec.h | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 4414853e84..64ba039be2 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -4892,7 +4892,8 @@ int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
* @param frame This will be set to a reference-counted video or audio
* frame (depending on the decoder type) allocated by the
* decoder. Note that the function will always call
- * av_frame_unref(frame) before doing anything else.
+ * @ref av_frame_unref "av_frame_unref(frame)" before doing
+ * anything else.
*
* @return
* 0: success, a frame was returned
@@ -4948,7 +4949,8 @@ int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
* @param avctx codec context
* @param avpkt This will be set to a reference-counted packet allocated by the
* encoder. Note that the function will always call
- * av_frame_unref(frame) before doing anything else.
+ * @ref av_packet_unref "av_packet_unref(avpkt)" before doing
+ * anything else.
* @return 0 on success, otherwise negative error code:
* AVERROR(EAGAIN): output is not available in the current state - user
* must try to send input
-- 
2.20.1




More information about the ffmpeg-devel mailing list