Merge branch 'v0.17.x'

1 files changed, 6 insertions, 0 deletions

diff --git a/src/encoder_plugin.h b/src/encoder_plugin.h
index 68a89d57..e0748a13 100644
--- a/src/encoder_plugin.h
+++ b/src/encoder_plugin.h
@@ -119,6 +119,10 @@ encoder_finish(struct encoder *encoder)
  * Before you free it, you must call encoder_close().  You may open
  * and close (reuse) one encoder any number of times.
  *
+ * After this function returns successfully and before the first
+ * encoder_write() call, you should invoke encoder_read() to obtain
+ * the file header.
+ *
  * @param encoder the encoder
  * @param audio_format the encoder's input audio format; the plugin
  * may modify the struct to adapt it to its abilities
@@ -291,6 +295,8 @@ encoder_write(struct encoder *encoder, const void *data, size_t length,
 /**
  * Reads encoded data from the encoder.
  *
+ * Call this repeatedly until no more data is returned.
+ *
  * @param encoder the encoder
  * @param dest the destination buffer to copy to
  * @param length the maximum length of the destination buffer