diff mbox series

[FFmpeg-devel] avformat/avformat.h: elaborate documentation for avformat_open_input() on error condition

Message ID 20240209220801.1583974-1-marth64@proxyid.net
State New
Headers show
Series [FFmpeg-devel] avformat/avformat.h: elaborate documentation for avformat_open_input() on error condition | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Marth64 Feb. 9, 2024, 10:08 p.m. UTC 
Signed-off-by: Marth64 <marth64@proxyid.net>
---
 libavformat/avformat.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 5d0fe82250..070ed7023d 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -2175,7 +2175,7 @@  int av_probe_input_buffer(AVIOContext *pb, const AVInputFormat **fmt,
  *                 which case an AVFormatContext is allocated by this
  *                 function and written into ps.
  *                 Note that a user-supplied AVFormatContext will be freed
- *                 on failure.
+ *                 on failure and its pointer set to NULL.
  * @param url      URL of the stream to open.
  * @param fmt      If non-NULL, this parameter forces a specific input format.
  *                 Otherwise the format is autodetected.
@@ -2184,7 +2184,8 @@  int av_probe_input_buffer(AVIOContext *pb, const AVInputFormat **fmt,
  *                 On return this parameter will be destroyed and replaced with
  *                 a dict containing options that were not found. May be NULL.
  *
- * @return 0 on success, a negative AVERROR on failure.
+ * @return 0 on success; on failure: frees ps, sets its pointer to NULL,
+ *         and returns a negative AVERROR.
  *
  * @note If you want to use custom IO, preallocate the format context and set its pb field.
  */