avcodec/v4l2_buffers: More clear return code documentation
authorMichael Niedermayer <michael@niedermayer.cc>
Fri, 29 Sep 2017 00:28:42 +0000 (02:28 +0200)
committerMichael Niedermayer <michael@niedermayer.cc>
Sun, 1 Oct 2017 00:35:15 +0000 (02:35 +0200)
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
libavcodec/v4l2_buffers.h

index b16f694..e28a4a6 100644 (file)
@@ -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
  *
  * @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);
 
  */
 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
  *
  * @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);
  *
  */
 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
  *
  * @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);
 
  */
 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
  *
  * @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);
 
  */
 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
  *
  * @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);
 
  */
 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
  *
  *
  * @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);
 
  */
 int ff_v4l2_buffer_enqueue(V4L2Buffer* avbuf);