avio: document avio_close().

e782a0c6 · Anton Khirnov · 893816ba · e782a0c6
Commit e782a0c6 authored Apr 09, 2011 by Anton Khirnov
Hide whitespace changes
Inline Side-by-side

Showing with 6 additions and 0 deletions

avio.h libavformat/avio.h +6 -0

No files found.
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -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);

 /**