doxygen: Include libavcodec and libavformat examples into the documentation
authorReinhard Tartler <siretart@tauware.de>
Thu, 30 Jun 2011 19:06:25 +0000 (21:06 +0200)
committerReinhard Tartler <siretart@tauware.de>
Thu, 30 Jun 2011 19:19:16 +0000 (21:19 +0200)
Doxyfile
libavcodec/api-example.c
libavformat/output-example.c

index 5d80a2b6f50c182d8056881a376288b5194dad33..6f32da6540ca469c66e77acf76e7abcc1ee1f359 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -591,7 +591,7 @@ EXCLUDE_SYMBOLS        =
 # directories that contain example code fragments that are included (see
 # the \include command).
 
-EXAMPLE_PATH           =
+EXAMPLE_PATH           = libavcodec/api-example.c libavformat/output-example.c
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
index 0221a30925870e39cab454fbaaad2244eb18cbfc..1792d60d7747a1289dad1ea3f54968e1e16c3e92 100644 (file)
@@ -20,8 +20,9 @@
 
 /**
  * @file
- * avcodec API use example.
+ * libavcodec API use example.
  *
+ * @example libavcodec/api-example.c
  * Note that this library only handles codecs (mpeg, mpeg4, etc...),
  * not file formats (avi, vob, etc...). See library 'libavformat' for the
  * format handling
index ddd16f1eed7485b7b9818895b89fbd95b8a7d93f..4453c03039cd05f6824cbc2ef28c0dbfa4d9506d 100644 (file)
@@ -1,7 +1,4 @@
 /*
- * Libavformat API example: Output a media file in any supported
- * libavformat format. The default codecs are used.
- *
  * Copyright (c) 2003 Fabrice Bellard
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  * THE SOFTWARE.
  */
+
+/**
+ * @file
+ * libavformat API example.
+ *
+ * @example libavformat/output-example.c
+ * Output a media file in any supported libavformat format.
+ * The default codecs are used.
+ */
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>