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

[michael]

Author: michael
Date: Fri Mar 21 23:17:56 2008
New Revision: 12548

Log:
Document get_*_buffer()


Modified:
   trunk/libavformat/avio.h

Modified: trunk/libavformat/avio.h
==============================================================================
--- trunk/libavformat/avio.h	(original)
+++ trunk/libavformat/avio.h	Fri Mar 21 23:17:56 2008
@@ -260,7 +260,19 @@ char *url_fgets(ByteIOContext *s, char *
 
 void put_flush_packet(ByteIOContext *s);
 
+
+/**
+ * Reads size bytes from ByteIOContext into buf.
+ * @returns number of bytes read or AVERROR
+ */
 int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
+
+/**
+ * Reads size bytes from ByteIOContext into buf.
+ * This reads at most 1 packet. If thats not enough fewer bytes will be
+ * returned.
+ * @returns number of bytes read or AVERROR
+ */
 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
 
 /** @note return 0 if EOF, so you cannot use it if EOF handling is