doc: extend dav1d_flush Doxygen

a1fb2664 · Janne Grunau · Ronald S. Bultje · eb31119d · a1fb2664
Commit a1fb2664 authored Nov 28, 2018 by Janne Grunau Committed by Ronald S. Bultje Nov 29, 2018
Hide whitespace changes
Inline Side-by-side

Showing with 6 additions and 1 deletion

include/dav1d/dav1d.h include/dav1d/dav1d.h +6 -1

No files found.
--- a/include/dav1d/dav1d.h
+++ b/include/dav1d/dav1d.h
@@ -172,9 +172,14 @@ DAV1D_API int dav1d_get_picture(Dav1dContext *c, Dav1dPicture *out);
 DAV1D_API void dav1d_close(Dav1dContext **c_out);

 /**
- * Flush all delayed frames in decoder, to be used when seeking.
+ * Flush all delayed frames in decoder and clear internal decoder state,
+ * to be used when seeking.
 *
 * @param c Input decoder instance.
+ *
+ * @note Decoding will start only after a valid sequence header OBU is
+ *       delivered to dav1d_send_data().
+ *
 */
 DAV1D_API void dav1d_flush(Dav1dContext *c);