document how to free the result of av_alloc_format_context()

Originally committed as revision 11225 to svn://svn.ffmpeg.org/ffmpeg/trunk

1 files changed, 5 insertions, 1 deletions

diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 9c8419a6a9..bc6f3f1179 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -569,7 +569,11 @@ int av_open_input_file(AVFormatContext **ic_ptr, const char *filename,
                        AVInputFormat *fmt,
                        int buf_size,
                        AVFormatParameters *ap);
-/** no av_open for output, so applications will need this: */
+/**
+ * Allocate an AVFormatContext.
+ * can be freed with av_free() but dont forget to free everything you
+ * explicitly allocated as well!
+ */
 AVFormatContext *av_alloc_format_context(void);
 
 /**