# HG changeset patch
# User michael
# Date 1206137876 0
# Node ID e5c7e9eac774628ee110d44789c30a065851645a
# Parent  cb3eb255f80d510db0c11335762103203ddbd436
Document get_*_buffer()

diff -r cb3eb255f80d -r e5c7e9eac774 avio.h
--- a/avio.h	Fri Mar 21 14:30:45 2008 +0000
+++ b/avio.h	Fri Mar 21 22:17:56 2008 +0000
@@ -260,7 +260,19 @@
 
 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