[FFmpeg-cvslog] r20988 - trunk/libavformat/avformat.h

[stefano]

Author: stefano
Date: Thu Dec 31 17:38:21 2009
New Revision: 20988

Log:
Document guess_format().

Modified:
   trunk/libavformat/avformat.h

Modified: trunk/libavformat/avformat.h
==============================================================================
--- trunk/libavformat/avformat.h	Thu Dec 31 15:12:58 2009	(r20987)
+++ trunk/libavformat/avformat.h	Thu Dec 31 17:38:21 2009	(r20988)
@@ -717,6 +717,19 @@ attribute_deprecated AVOutputFormat *gue
                                     const char *filename,
                                     const char *mime_type);
 #endif
+
+/**
+ * Returns the output format in the list of registered output formats
+ * which best matches the provided parameters, or returns NULL if
+ * there is no match.
+ *
+ * @param short_name if non-NULL checks if short_name matches with the
+ * names of the registered formats
+ * @param filename if non-NULL checks if filename terminates with the
+ * extensions of the registered formats
+ * @param mime_type if non-NULL checks if mime_type matches with the
+ * MIME type of the registered formats
+ */
 AVOutputFormat *guess_format(const char *short_name,
                              const char *filename,
                              const char *mime_type);