aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorReinhard Tartler <siretart@tauware.de>2011-06-30 21:06:25 +0200
committerReinhard Tartler <siretart@tauware.de>2011-06-30 21:19:16 +0200
commitd7537a6fce140876405a66f059f14e190527388d (patch)
tree5d29e6f9e4fba4e2ee030fe3b21422fb5a596b23
parent192bfbc1f18d50afea03c2d62ce5325fabb2f141 (diff)
downloadffmpeg-d7537a6fce140876405a66f059f14e190527388d.tar.gz
doxygen: Include libavcodec and libavformat examples into the documentation
-rw-r--r--Doxyfile2
-rw-r--r--libavcodec/api-example.c3
-rw-r--r--libavformat/output-example.c13
3 files changed, 13 insertions, 5 deletions
diff --git a/Doxyfile b/Doxyfile
index 5d80a2b6f5..6f32da6540 100644
--- 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
diff --git a/libavcodec/api-example.c b/libavcodec/api-example.c
index 0221a30925..1792d60d77 100644
--- a/libavcodec/api-example.c
+++ b/libavcodec/api-example.c
@@ -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
diff --git a/libavformat/output-example.c b/libavformat/output-example.c
index ddd16f1eed..4453c03039 100644
--- a/libavformat/output-example.c
+++ b/libavformat/output-example.c
@@ -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
@@ -22,6 +19,16 @@
* 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>