# HG changeset patch
# User michael
# Date 1206098827 0
# Node ID 103f156dd8cc86c6b4bf8905214483b4c5b8b921
# Parent  125b08d2ad59003a48ebbf810f428821eb31f404
Document a few url_* functions.

diff -r 125b08d2ad59 -r 103f156dd8cc avio.h
--- a/avio.h	Fri Mar 21 11:16:16 2008 +0000
+++ b/avio.h	Fri Mar 21 11:27:07 2008 +0000
@@ -207,11 +207,36 @@
 
 void put_strz(ByteIOContext *s, const char *buf);
 
+/**
+ * fseek() equivalent for ByteIOContext.
+ * @return new position or AVERROR.
+ */
 offset_t url_fseek(ByteIOContext *s, offset_t offset, int whence);
+
+/**
+ * Skip given number of bytes forward.
+ * @param offset number of bytes
+ */
 void url_fskip(ByteIOContext *s, offset_t offset);
+
+/**
+ * ftell() equivalent for ByteIOContext.
+ * @return position or AVERROR.
+ */
 offset_t url_ftell(ByteIOContext *s);
+
+/**
+ * Gets the filesize.
+ * @return filesize or AVERROR
+ */
 offset_t url_fsize(ByteIOContext *s);
+
+/**
+ * feof() equivalent for ByteIOContext.
+ * @return non zero if and only if end of file
+ */
 int url_feof(ByteIOContext *s);
+
 int url_ferror(ByteIOContext *s);
 
 int av_url_read_fpause(ByteIOContext *h, int pause);