diff mbox series

[FFmpeg-devel,10/12] avformat/av1: Fix nits in the documentation of ff_av1_filter_obus_buf()

Message ID 20200124224833.17579-4-andreas.rheinhardt@gmail.com
State Accepted
Headers show
Series [FFmpeg-devel,1/6] avformat/matroskaenc: Check for reformatting errors
Related show

Checks

Context Check Description
andriy/ffmpeg-patchwork pending
andriy/ffmpeg-patchwork success Applied patch
andriy/ffmpeg-patchwork success Configure finished
andriy/ffmpeg-patchwork success Make finished
andriy/ffmpeg-patchwork success Make fate finished

Commit Message

Andreas Rheinhardt Jan. 24, 2020, 10:48 p.m. UTC
Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@gmail.com>
---
 libavformat/av1.h | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

Comments

James Almer Jan. 26, 2020, 3:54 p.m. UTC | #1
On 1/24/2020 7:48 PM, Andreas Rheinhardt wrote:
> Signed-off-by: Andreas Rheinhardt <andreas.rheinhardt@gmail.com>
> ---
>  libavformat/av1.h | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/libavformat/av1.h b/libavformat/av1.h
> index 52d0814e86..6cc3fcaad2 100644
> --- a/libavformat/av1.h
> +++ b/libavformat/av1.h
> @@ -59,15 +59,13 @@ int ff_av1_filter_obus(AVIOContext *pb, const uint8_t *buf, int size);
>   * Filter out AV1 OBUs not meant to be present in ISOBMFF sample data and write
>   * the resulting bitstream to a newly allocated data buffer.
>   *
> - * @param pb pointer to the AVIOContext where the filtered bitstream shall be
> - *           written
>   * @param in input data buffer
>   * @param out pointer to pointer that will hold the allocated data buffer
>   * @param size size of the input data buffer. The size of the resulting output
> -               data buffer will be written here
> + *             data buffer will be written here
>   *
>   * @return 0 in case of success, a negative AVERROR code in case of failure.
> - *         On failure, out and size are unchanged
> + *         On failure, *out and *size are unchanged
>   * @note *out will be treated as unintialized on input and will not be freed.
>   */
>  int ff_av1_filter_obus_buf(const uint8_t *in, uint8_t **out, int *size);

Pushed.
diff mbox series

Patch

diff --git a/libavformat/av1.h b/libavformat/av1.h
index 52d0814e86..6cc3fcaad2 100644
--- a/libavformat/av1.h
+++ b/libavformat/av1.h
@@ -59,15 +59,13 @@  int ff_av1_filter_obus(AVIOContext *pb, const uint8_t *buf, int size);
  * Filter out AV1 OBUs not meant to be present in ISOBMFF sample data and write
  * the resulting bitstream to a newly allocated data buffer.
  *
- * @param pb pointer to the AVIOContext where the filtered bitstream shall be
- *           written
  * @param in input data buffer
  * @param out pointer to pointer that will hold the allocated data buffer
  * @param size size of the input data buffer. The size of the resulting output
-               data buffer will be written here
+ *             data buffer will be written here
  *
  * @return 0 in case of success, a negative AVERROR code in case of failure.
- *         On failure, out and size are unchanged
+ *         On failure, *out and *size are unchanged
  * @note *out will be treated as unintialized on input and will not be freed.
  */
 int ff_av1_filter_obus_buf(const uint8_t *in, uint8_t **out, int *size);