[FFmpeg-cvslog] avcodec/v4l2_buffers: More clear return code documentation

[Michael Niedermayer]

ffmpeg | branch: master | Michael Niedermayer <michael at niedermayer.cc> | Fri Sep 29 02:28:42 2017 +0200| [4bb80133356b67f5065883d05d474d67cfee1dd8] | committer: Michael Niedermayer

avcodec/v4l2_buffers: More clear return code documentation

Signed-off-by: Michael Niedermayer <michael at niedermayer.cc>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=4bb80133356b67f5065883d05d474d67cfee1dd8
---

 libavcodec/v4l2_buffers.h | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/libavcodec/v4l2_buffers.h b/libavcodec/v4l2_buffers.h
index b16f694b98..e28a4a650d 100644
--- a/libavcodec/v4l2_buffers.h
+++ b/libavcodec/v4l2_buffers.h
@@ -65,8 +65,8 @@ typedef struct V4L2Buffer {
  * @param[in] frame The AVFRame to push the information to
  * @param[in] buf The V4L2Buffer to get the information from
  *
- * @returns 0 in case of success, EINVAL if the number of planes is incorrect,
- * ENOMEM if the AVBufferRef cant be created.
+ * @returns 0 in case of success, AVERROR(EINVAL) if the number of planes is incorrect,
+ * AVERROR(ENOMEM) if the AVBufferRef cant be created.
  */
 int ff_v4l2_buffer_buf_to_avframe(AVFrame *frame, V4L2Buffer *buf);
 
@@ -76,8 +76,8 @@ int ff_v4l2_buffer_buf_to_avframe(AVFrame *frame, V4L2Buffer *buf);
  * @param[in] pkt The AVPacket to push the information to
  * @param[in] buf The V4L2Buffer to get the information from
  *
- * @returns 0 in case of success, EINVAL if the number of planes is incorrect,
- * ENOMEM if the AVBufferRef cant be created.
+ * @returns 0 in case of success, AVERROR(EINVAL) if the number of planes is incorrect,
+ * AVERROR(ENOMEM) if the AVBufferRef cant be created.
  *
  */
 int ff_v4l2_buffer_buf_to_avpkt(AVPacket *pkt, V4L2Buffer *buf);
@@ -88,7 +88,7 @@ int ff_v4l2_buffer_buf_to_avpkt(AVPacket *pkt, V4L2Buffer *buf);
  * @param[in]  frame AVPacket to get the data from
  * @param[in]  avbuf V4L2Bfuffer to push the information to
  *
- * @returns 0 in case of success, negative otherwise
+ * @returns 0 in case of success, a negative AVERROR code otherwise
  */
 int ff_v4l2_buffer_avpkt_to_buf(const AVPacket *pkt, V4L2Buffer *out);
 
@@ -98,7 +98,7 @@ int ff_v4l2_buffer_avpkt_to_buf(const AVPacket *pkt, V4L2Buffer *out);
  * @param[in]  frame AVFrame to get the data from
  * @param[in]  avbuf V4L2Bfuffer to push the information to
  *
- * @returns 0 in case of success, negative otherwise
+ * @returns 0 in case of success, a negative AVERROR code otherwise
  */
 int ff_v4l2_buffer_avframe_to_buf(const AVFrame *frame, V4L2Buffer* out);
 
@@ -108,7 +108,7 @@ int ff_v4l2_buffer_avframe_to_buf(const AVFrame *frame, V4L2Buffer* out);
  * @param[in]  avbuf V4L2Bfuffer to initialize
  * @param[in]  index v4l2 buffer id
  *
- * @returns 0 in case of success, negative otherwise
+ * @returns 0 in case of success, a negative AVERROR code otherwise
  */
 int ff_v4l2_buffer_initialize(V4L2Buffer* avbuf, int index);
 
@@ -117,7 +117,7 @@ int ff_v4l2_buffer_initialize(V4L2Buffer* avbuf, int index);
  *
  * @param[in] avbuf V4L2Bfuffer to push to the driver
  *
- * @returns 0 in case of success, negative otherwise
+ * @returns 0 in case of success, a negative AVERROR code otherwise
  */
 int ff_v4l2_buffer_enqueue(V4L2Buffer* avbuf);