Document get_*_buffer()

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

diff --git a/libavformat/avio.h b/libavformat/avio.h
index b9a4997801cdd7a967e1123e9bdc06de46f41544..61459c53917a4be7235904e294ed6e54e230b3d9 100644 (file)
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -260,7 +260,19 @@ char *url_fgets(ByteIOContext *s, char *buf, int buf_size);
 
 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