[FFmpeg-cvslog] avcodec/bsf: improve the doxy for av_bsf_flush()

[James Almer]

ffmpeg | branch: master | James Almer <jamrial at gmail.com> | Mon Aug 10 15:03:46 2020 -0300| [161d7f3fee7467b96832cb8773b740065db194fb] | committer: James Almer

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 at gmail.com>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=161d7f3fee7467b96832cb8773b740065db194fb
---

 libavcodec/bsf.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/libavcodec/bsf.h b/libavcodec/bsf.h
index 7ed51677e8..3b5faa85cb 100644
--- 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);