[FFmpeg-cvslog] doc/examples: misc Doxygen markup improvements

Diego Biurrun git at videolan.org
Fri Feb 14 15:37:05 CET 2014


ffmpeg | branch: master | Diego Biurrun <diego at biurrun.de> | Tue Feb 11 15:49:39 2014 +0100| [0b9716c45568890dd1ff1b7cc5946c59eb3452e5] | committer: Diego Biurrun

doc/examples: misc Doxygen markup improvements

Add properly formatted @example tag and fix Doxygen syntax.

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

 doc/examples/output.c        |    4 ++--
 doc/examples/transcode_aac.c |    5 ++++-
 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 at gmail.com)
  */



More information about the ffmpeg-cvslog mailing list