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

[stefano]

Author: stefano
Date: Sat Feb  6 00:03:32 2010
New Revision: 21647

Log:
Doxument url_fdopen().

Modified:
   trunk/libavformat/avio.h

Modified: trunk/libavformat/avio.h
==============================================================================
--- trunk/libavformat/avio.h	Fri Feb  5 16:26:42 2010	(r21646)
+++ trunk/libavformat/avio.h	Sat Feb  6 00:03:32 2010	(r21647)
@@ -381,8 +381,17 @@ static inline int url_is_streamed(ByteIO
     return s->is_streamed;
 }
 
-/** @note when opened as read/write, the buffers are only used for
-    writing */
+/**
+ * Creates and initializes a ByteIOContext for accessing the
+ * resource referenced by the URLContext h.
+ * @note When the URLContext h 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.
+ * @return 0 in case of success, a negative value corresponding to an
+ * AVERROR code in case of failure
+ */
 int url_fdopen(ByteIOContext **s, URLContext *h);
 
 /** @warning must be called before any I/O */