[FFmpeg-devel] [PATCH] doxygen: clarify purpose of AVIOInterruptCB

Lukasz Marek lukasz.m.luki at gmail.com
Sat Aug 31 00:02:50 CEST 2013


Signed-off-by: Lukasz Marek <lukasz.m.luki at gmail.com>
---
 libavformat/avio.h |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)

diff --git a/libavformat/avio.h b/libavformat/avio.h
index 5bdbc62..0a3078b 100644
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -47,6 +47,10 @@
  * No members can be added to this struct without a major bump, if
  * new elements have been added after this struct in AVFormatContext
  * or AVIOContext.
+ *
+ * @note This functionality is not intended to be used by protocols
+ *       nor any other in-between layers of ffmpeg. This is designed
+ *       to be used by high-level clients like ff* tools.
  */
 typedef struct AVIOInterruptCB {
     int (*callback)(void*);
-- 
1.7.2.5



More information about the ffmpeg-devel mailing list