summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDiego Biurrun <diego@biurrun.de>2014-02-11 15:49:39 +0100
committerDiego Biurrun <diego@biurrun.de>2014-02-14 12:01:36 +0100
commit0b9716c45568890dd1ff1b7cc5946c59eb3452e5 (patch)
treee1575ce1f60ddd1959766a4ec60ef20bd3abf008 /doc
parent3a26ccbf0d9f806d067e76a3f484170abecb36b3 (diff)
downloadffmpeg-streaming-0b9716c45568890dd1ff1b7cc5946c59eb3452e5.zip
ffmpeg-streaming-0b9716c45568890dd1ff1b7cc5946c59eb3452e5.tar.gz
doc/examples: misc Doxygen markup improvements
Add properly formatted @example tag and fix Doxygen syntax.
Diffstat (limited to 'doc')
-rw-r--r--doc/examples/output.c4
-rw-r--r--doc/examples/transcode_aac.c5
2 files changed, 6 insertions, 3 deletions
diff --git a/doc/examples/output.c b/doc/examples/output.c
index 06fdf50..3be85de 100644
--- a/doc/examples/output.c
+++ b/doc/examples/output.c
@@ -25,8 +25,8 @@
* libavformat API example.
*
* @example doc/examples/output.c
- * Output a media file in any supported libavformat format.
- * The default codecs are used.
+ * Output a media file in any supported libavformat format. The default
+ * codecs are used.
*/
#include <stdlib.h>
diff --git a/doc/examples/transcode_aac.c b/doc/examples/transcode_aac.c
index 46f61d8..07f7fe7 100644
--- a/doc/examples/transcode_aac.c
+++ b/doc/examples/transcode_aac.c
@@ -17,7 +17,10 @@
*/
/**
- * @file simple audio converter
+ * @file
+ * simple audio converter
+ *
+ * @example doc/examples/transcode_aac.c
* Convert an input audio file to AAC in an MP4 container using Libav.
* @author Andreas Unterweger (dustsigns@gmail.com)
*/
OpenPOWER on IntegriCloud