From: Stefano Sabatini <stefano.sabatini-lala@poste.it>
Date: Tue, 9 Feb 2010 18:59:34 +0000 (+0000)
Subject: Doxument url_fopen().
X-Git-Tag: v0.6~1392
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=fe4fbb583d1f337c929e4cbc4c42af45b91fff02;p=platform%2Fupstream%2Flibav.git

Doxument url_fopen().

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

diff --git a/libavformat/avio.h b/libavformat/avio.h
index b929995..80ec48f 100644
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -404,9 +404,21 @@ int url_setbufsize(ByteIOContext *s, int buf_size);
 int url_resetbuf(ByteIOContext *s, int flags);
 #endif
 
-/** @note when opened as read/write, the buffers are only used for
-    writing */
+/**
+ * Creates and initializes a ByteIOContext for accessing the
+ * resource indicated by url.
+ * @note When the resource indicated by url has been opened in
+ * read+write mode, the ByteIOContext can be used only for writing.
+ *
+ * @param s Used to return the pointer to the created ByteIOContext.
+ * In case of failure the pointed to value is set to NULL.
+ * @param flags flags which control how the resource indicated by url
+ * is to be opened
+ * @return 0 in case of success, a negative value corresponding to an
+ * AVERROR code in case of failure
+ */
 int url_fopen(ByteIOContext **s, const char *url, int flags);
+
 int url_fclose(ByteIOContext *s);
 URLContext *url_fileno(ByteIOContext *s);