# HG changeset patch
# User michael
# Date 1186762523 0
# Node ID 43a4290a6d7763e1c1dcdc823211f62b21543e3b
# Parent  ddc8034208a5b712dc0a05289a65fee4eb868bb1
mention AVPROBE_PADDING_SIZE at the read_probe() doxy

diff -r ddc8034208a5 -r 43a4290a6d77 avformat.h
--- a/avformat.h	Fri Aug 10 16:12:50 2007 +0000
+++ b/avformat.h	Fri Aug 10 16:15:23 2007 +0000
@@ -197,7 +197,11 @@
     const char *long_name;
     /** size of private data so that it can be allocated in the wrapper */
     int priv_data_size;
-    /** tell if a given file has a chance of being parsed by this format */
+    /**
+     * tell if a given file has a chance of being parsed by this format.
+     * The buffer provided is guranteed to be AVPROBE_PADDING_SIZE bytes big
+     * so you dont have to check for that unless you need more.
+     */
     int (*read_probe)(AVProbeData *);
     /** read the format header and initialize the AVFormatContext
        structure. Return 0 if OK. 'ap' if non NULL contains