[FFmpeg-cvslog] doxygen: Include libavcodec and libavformat examples into the documentation

[Reinhard Tartler]

ffmpeg | branch: master | Reinhard Tartler <siretart at tauware.de> | Thu Jun 30 21:06:25 2011 +0200| [d7537a6fce140876405a66f059f14e190527388d] | committer: Reinhard Tartler

doxygen: Include libavcodec and libavformat examples into the documentation

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=d7537a6fce140876405a66f059f14e190527388d
---

 Doxyfile                     |    2 +-
 libavcodec/api-example.c     |    3 ++-
 libavformat/output-example.c |   13 ++++++++++---
 3 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/Doxyfile b/Doxyfile
index 5d80a2b..6f32da6 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 0221a30..1792d60 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 ddd16f1..4453c03 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>