[FFmpeg-devel] [PATCH] libavformat: Fix the docs for av_mime_codec_str and ff_make_codec_str (PR #21244)

[FFmpeg-devel] [PATCH] libavformat: Fix the docs for av_mime_codec_str and ff_make_codec_str (PR #21244)

[Martin Storsjö via ffmpeg-devel]

PR #21244 opened by Martin Storsjö (mstorsjo)
URL: https://code.ffmpeg.org/FFmpeg/FFmpeg/pulls/21244
Patch URL: https://code.ffmpeg.org/FFmpeg/FFmpeg/pulls/21244.patch

The doxygen comments were missed as these functions were updated
during review; they don't take separate pointer/length parameters
but use an AVBPrint struct now instead.


From b0230391f06b514f7b0cf7efb6cabc5d93261be0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Martin=20Storsj=C3=B6?= <martin@martin.st>
Date: Fri, 19 Dec 2025 20:07:19 +0200
Subject: [PATCH] libavformat: Fix the docs for av_mime_codec_str and
 ff_make_codec_str

The doxygen comments were missed as these functions were updated
during review; they don't take separate pointer/length parameters
but use an AVBPrint struct now instead.
---
 libavformat/avformat.h | 3 +--
 libavformat/internal.h | 3 +--
 2 files changed, 2 insertions(+), 4 deletions(-)

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index cee845b308..bd34132e00 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -2898,8 +2898,7 @@ struct AVBPrint;
  * @param frame_rate an AVRational for the frame rate, for deciding the
  *                   right profile for video codecs. Pass an invalid
  *                   AVRational (1/0) to indicate that it is unknown.
- * @param str the output string buffer
- * @param size the size of the string pointed to by str
+ * @param out the AVBPrint to write the output to
  * @return <0 on error
  */
 int av_mime_codec_str(const AVCodecParameters *par,
diff --git a/libavformat/internal.h b/libavformat/internal.h
index d32a3376cc..380676ed23 100644
--- a/libavformat/internal.h
+++ b/libavformat/internal.h
@@ -668,8 +668,7 @@ int ff_parse_opts_from_query_string(void *obj, const char *str, int allow_unkown
  * @param par pointer to an AVCodecParameters struct describing the codec
  * @param frame_rate an optional pointer to AVRational for the frame rate,
  *                   for deciding the right profile for video codecs
- * @param str the output string buffer
- * @param size the size of the string pointed to by str
+ * @param out the AVBPrint to write the output to
  * @return <0 on error
  */
 int ff_make_codec_str(void *logctx, const AVCodecParameters *par,
-- 
2.49.1

_______________________________________________
ffmpeg-devel mailing list -- ffmpeg-devel@ffmpeg.org
To unsubscribe send an email to ffmpeg-devel-leave@ffmpeg.org