shithub: dav1d

Download patch

ref: 04dc8a4d629fbefa7dc5f3614ce95a94a0b32f46
parent: c1b3e1a9c77cd27d9a7326a6858de29f0b6f484f
author: Marvin Scholz <epirat07@gmail.com>
date: Wed May 22 07:38:43 EDT 2019 

include: Consistently use DAV1D_ERR in docs


--- a/include/dav1d/dav1d.h
+++ b/include/dav1d/dav1d.h
@@ -144,7 +144,7 @@
  *                                  passed-in arguments.
  *
  * @note To drain buffered frames from the decoder (i.e. on end of stream),
- *       call this function until it returns -EAGAIN.
+ *       call this function until it returns DAV1D_ERR(EAGAIN).
  *
  * @code{.c}
  *  Dav1dData data = { 0 };
@@ -157,11 +157,11 @@
  *      // Keep going even if the function can't consume the current data
  *         packet. It eventually will after one or more frames have been
  *         returned in this loop.
- *      if (res < 0 && res != -EAGAIN)
+ *      if (res < 0 && res != DAV1D_ERR(EAGAIN))
  *          free_and_abort();
  *      res = dav1d_get_picture(c, &p);
  *      if (res < 0) {
- *          if (res != -EAGAIN)
+ *          if (res != DAV1D_ERR(EAGAIN))
  *              free_and_abort();
  *      } else
  *          output_and_unref_picture(&p);
@@ -172,7 +172,7 @@
  *  do {
  *      res = dav1d_get_picture(c, &p);
  *      if (res < 0) {
- *          if (res != -EAGAIN)
+ *          if (res != DAV1D_ERR(EAGAIN))
  *              free_and_abort();
  *      } else
  *          output_and_unref_picture(&p);