[FFmpeg-cvslog] r21714 - trunk/libavformat/avio.h

[stefano]

Author: stefano
Date: Tue Feb  9 19:59:34 2010
New Revision: 21714

Log:
Doxument url_fopen().

Modified:
   trunk/libavformat/avio.h

Modified: trunk/libavformat/avio.h
==============================================================================
--- trunk/libavformat/avio.h	Tue Feb  9 19:58:02 2010	(r21713)
+++ trunk/libavformat/avio.h	Tue Feb  9 19:59:34 2010	(r21714)
@@ -404,9 +404,21 @@ int url_setbufsize(ByteIOContext *s, int
 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);