Add info to dav1d_send_data docsHEADmaster

1 files changed, 8 insertions, 6 deletions

diff --git a/include/dav1d/dav1d.h b/include/dav1d/dav1d.h
index da71e58..237ce3e 100644
--- a/include/dav1d/dav1d.h
+++ b/include/dav1d/dav1d.h
@@ -126,7 +126,7 @@ DAV1D_API int dav1d_open(Dav1dContext **c_out, const Dav1dSettings *s);
  *                  0: Success, and out is filled with the parsed Sequence Header
  *                     OBU parameters.
  *  DAV1D_ERR(ENOENT): No Sequence Header OBUs were found in the buffer.
- *  other negative DAV1D_ERR codes: Invalid data in the buffer, invalid passed-in
+ *  Other negative DAV1D_ERR codes: Invalid data in the buffer, invalid passed-in
  *                                  arguments, and other errors during parsing.
  *
  * @note It is safe to feed this function data containing other OBUs than a
@@ -137,7 +137,8 @@ DAV1D_API int dav1d_parse_sequence_header(Dav1dSequenceHeader *out,
                                           const uint8_t *buf, const size_t sz);
 
 /**
- * Feed bitstream data to the decoder.
+ * Feed bitstream data to the decoder, in the form of one or multiple AV1
+ * Open Bitstream Units (OBUs).
  *
  * @param   c Input decoder instance.
  * @param  in Input bitstream data. On success, ownership of the reference is
@@ -148,8 +149,9 @@ DAV1D_API int dav1d_parse_sequence_header(Dav1dSequenceHeader *out,
  *  DAV1D_ERR(EAGAIN): The data can't be consumed. dav1d_get_picture() should
  *                     be called to get one or more frames before the function
  *                     can consume new data.
- *  other negative DAV1D_ERR codes: Error during decoding or because of invalid
- *                                  passed-in arguments.
+ *  Other negative DAV1D_ERR codes: Error during decoding or because of invalid
+ *                                  passed-in arguments. The reference remains
+ *                                  owned by the caller.
  */
 DAV1D_API int dav1d_send_data(Dav1dContext *c, Dav1dData *in);
 
@@ -164,7 +166,7 @@ DAV1D_API int dav1d_send_data(Dav1dContext *c, Dav1dData *in);
  *         0: Success, and a frame is returned.
  *  DAV1D_ERR(EAGAIN): Not enough data to output a frame. dav1d_send_data()
  *                     should be called with new input.
- *  other negative DAV1D_ERR codes: Error during decoding or because of invalid
+ *  Other negative DAV1D_ERR codes: Error during decoding or because of invalid
  *                                  passed-in arguments.
  *
  * @note To drain buffered frames from the decoder (i.e. on end of stream),
@@ -216,7 +218,7 @@ DAV1D_API int dav1d_get_picture(Dav1dContext *c, Dav1dPicture *out);
  *
  * @return
  *         0: Success, and a frame is returned.
- *  other negative DAV1D_ERR codes: Error due to lack of memory or because of
+ *  Other negative DAV1D_ERR codes: Error due to lack of memory or because of
  *                                  invalid passed-in arguments.
  *
  * @note If `Dav1dSettings.apply_grain` is true, film grain was already applied