avio: document avio_close().
authorAnton Khirnov <anton@khirnov.net>
Sat, 9 Apr 2011 10:43:51 +0000 (12:43 +0200)
committerAnton Khirnov <anton@khirnov.net>
Sun, 10 Apr 2011 05:41:56 +0000 (07:41 +0200)
libavformat/avio.h

index ca5dc2d..134df12 100644 (file)
@@ -555,6 +555,12 @@ int url_resetbuf(AVIOContext *s, int flags);
  */
 int avio_open(AVIOContext **s, const char *url, int flags);
 
+/**
+ * Close the resource accessed by the AVIOContext s and free it.
+ * This function can only be used if s was opened by avio_open().
+ *
+ * @return 0 on success, an AVERROR < 0 on error.
+ */
 int avio_close(AVIOContext *s);
 
 /**