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

[michael]

Author: michael
Date: Fri Mar 21 12:27:07 2008
New Revision: 12537

Log:
Document a few url_* functions.


Modified:
   trunk/libavformat/avio.h

Modified: trunk/libavformat/avio.h
==============================================================================
--- trunk/libavformat/avio.h	(original)
+++ trunk/libavformat/avio.h	Fri Mar 21 12:27:07 2008
@@ -207,11 +207,36 @@ void put_tag(ByteIOContext *s, const cha
 
 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);