diff mbox series

[FFmpeg-devel,1/3] avcodec/bsf: improve the doxy for av_bsf_flush()

Message ID 20200810180615.5222-1-jamrial@gmail.com
State Accepted
Commit 161d7f3fee7467b96832cb8773b740065db194fb
Headers show
Series [FFmpeg-devel,1/3] avcodec/bsf: improve the doxy for av_bsf_flush()
Related show

Checks

Context Check Description
andriy/default pending
andriy/make success Make finished
andriy/make_fate success Make fate finished

Commit Message

James Almer Aug. 10, 2020, 6:06 p.m. UTC
Mention an example scenario where the function should be used.

Signed-off-by: James Almer <jamrial@gmail.com>
---
 libavcodec/bsf.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

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);