From e782a0c6da0daa7b65e0355e50e68b13441b5faa Mon Sep 17 00:00:00 2001
From: Anton Khirnov <anton@khirnov.net>
Date: Sat, 9 Apr 2011 12:43:51 +0200
Subject: avio: document avio_close().

---
 libavformat/avio.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'libavformat/avio.h')

diff --git a/libavformat/avio.h b/libavformat/avio.h
index ca5dc2d1ee..134df12057 100644
--- 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);
 
 /**
-- 
cgit v1.2.3