avcodec/bsf: improve the doxy for av_bsf_flush()

Mention an example scenario where the function should be used.

Signed-off-by: James Almer <jamrial@gmail.com>

diff --git a/libavcodec/bsf.h b/libavcodec/bsf.h
index 7ed51677e827a97357d341ec8a3e14680a153410..3b5faa85cb513cc055658edbadc012aaa22d89ed 100644 (file)
--- a/libavcodec/bsf.h
+++ b/libavcodec/bsf.h
@@ -215,7 +215,7 @@ int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
 
 /**
- * Reset the internal bitstream filter state / flush internal buffers.
+ * Reset the internal bitstream filter state. Should be called e.g. when seeking.
  */
 void av_bsf_flush(AVBSFContext *ctx);