diff mbox series

[FFmpeg-devel,v3,37/54] avutil/file: Add doxy for missing arguments

Message ID 20220925001121.37721-38-epirat07@gmail.com
State Accepted
Commit a679b875705e6e720a7a110dfea05061b47fa7fe
Headers show
Series Various Doxygen fixes | expand


Context Check Description
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Marvin Scholz Sept. 25, 2022, 12:11 a.m. UTC
 libavutil/file.h | 4 ++++
 1 file changed, 4 insertions(+)
diff mbox series


diff --git a/libavutil/file.h b/libavutil/file.h
index 511c100db4..fc87a9cd6a 100644
--- a/libavutil/file.h
+++ b/libavutil/file.h
@@ -39,6 +39,9 @@ 
  * case *bufptr will be set to NULL and *size will be set to 0.
  * The returned buffer must be released with av_file_unmap().
+ * @param filename path to the file
+ * @param[out] bufptr pointee is set to the mapped or allocated buffer
+ * @param[out] size pointee is set to the size in bytes of the buffer
  * @param log_offset loglevel offset used for logging
  * @param log_ctx context used for logging
  * @return a non negative number in case of success, a negative value
@@ -51,6 +54,7 @@  int av_file_map(const char *filename, uint8_t **bufptr, size_t *size,
  * Unmap or free the buffer bufptr created by av_file_map().
+ * @param bufptr the buffer previously created with av_file_map()
  * @param size size in bytes of bufptr, must be the same as returned
  * by av_file_map()