Doxument url_open_protocol().

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

1 files changed, 12 insertions, 0 deletions

diff --git a/libavformat/avio.h b/libavformat/avio.h
index 0ab351310e..d7b7e2630d 100644
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -65,8 +65,20 @@ typedef struct URLPollEntry {
 
 typedef int URLInterruptCB(void);
 
+/**
+ * Creates an URLContext for accessing to the resource indicated by
+ * filename, and opens it using the URLProtocol up.
+ *
+ * @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 filename
+ * 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_protocol (URLContext **puc, struct URLProtocol *up,
                        const char *filename, int flags);
+
 int url_open(URLContext **h, const char *filename, int flags);
 
 /**