diff mbox series

[FFmpeg-devel,1/3] lavc/avcodec.h: fix missing line breaks in API documentation

Message ID 1582820008-22183-1-git-send-email-linjie.fu@intel.com
State Accepted
Headers show
Series [FFmpeg-devel,1/3] lavc/avcodec.h: fix missing line breaks in API documentation
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

Fu, Linjie Feb. 27, 2020, 4:13 p.m. UTC
"In both cases.." and "Repeat this call until.." would be better to
be in a separate line.

http://ffmpeg.org/doxygen/trunk/group__lavc__encdec.html

Signed-off-by: Linjie Fu <linjie.fu@intel.com>
---
 libavcodec/avcodec.h | 2 ++
 1 file changed, 2 insertions(+)

Comments

Michael Niedermayer Feb. 28, 2020, 6:37 p.m. UTC | #1
On Fri, Feb 28, 2020 at 12:13:28AM +0800, Linjie Fu wrote:
> "In both cases.." and "Repeat this call until.." would be better to
> be in a separate line.
> 
> http://ffmpeg.org/doxygen/trunk/group__lavc__encdec.html
> 
> Signed-off-by: Linjie Fu <linjie.fu@intel.com>
> ---
>  libavcodec/avcodec.h | 2 ++
>  1 file changed, 2 insertions(+)

will apply
thx

[...]
diff mbox series

Patch

diff --git a/libavcodec/avcodec.h b/libavcodec/avcodec.h
index 894a9e5..5a0fc34 100644
--- a/libavcodec/avcodec.h
+++ b/libavcodec/avcodec.h
@@ -92,6 +92,7 @@ 
  *     compressed data in an AVPacket.
  *   - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
  *     containing uncompressed audio or video.
+ *
  *   In both cases, it is recommended that AVPackets and AVFrames are
  *   refcounted, or libavcodec might have to copy the input data. (libavformat
  *   always returns refcounted AVPackets, and av_frame_get_buffer() allocates
@@ -102,6 +103,7 @@ 
  *     an AVFrame containing uncompressed audio or video data.
  *   - For encoding, call avcodec_receive_packet(). On success, it will return
  *     an AVPacket with a compressed frame.
+ *
  *   Repeat this call until it returns AVERROR(EAGAIN) or an error. The
  *   AVERROR(EAGAIN) return value means that new input data is required to
  *   return new output. In this case, continue with sending input. For each