Doxument url_open().

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

1 files changed, 11 insertions, 0 deletions

diff --git a/libavformat/avio.h b/libavformat/avio.h
index 5c9b7dafb0..7227729297 100644
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -79,6 +79,17 @@ typedef int URLInterruptCB(void);
 int url_open_protocol (URLContext **puc, struct URLProtocol *up,
                        const char *url, int flags);
 
+/**
+ * Creates an URLContext for accessing to the resource indicated by
+ * url, and opens it.
+ *
+ * @param puc pointer to the location where, in case of success, the
+ * function puts the pointer to the created URLContext
+ * @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_open(URLContext **h, const char *url, int flags);
 
 /**