[FFmpeg-cvslog] misc Doxygen markup improvements

Diego Biurrun git at videolan.org
Tue Dec 6 01:53:38 CET 2011


ffmpeg | branch: master | Diego Biurrun <diego at biurrun.de> | Sun Oct 30 19:10:50 2011 +0100| [e873c03ac7cec62474fe8405391080abb78f4a02] | committer: Diego Biurrun

misc Doxygen markup improvements

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

 cmdutils.h                |    2 +-
 libavcodec/cinepak.c      |    7 ++++---
 libavcodec/eamad.c        |    4 ++--
 libavcodec/lsp.c          |    2 +-
 libavdevice/pulse.c       |    1 -
 libavdevice/x11grab.c     |    5 +++--
 libavformat/matroskadec.c |    8 ++++----
 libavformat/oggdec.c      |    5 ++---
 8 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/cmdutils.h b/cmdutils.h
index 55a06dd..fc438c7 100644
--- a/cmdutils.h
+++ b/cmdutils.h
@@ -190,7 +190,7 @@ void parse_loglevel(int argc, char **argv, const OptionDef *options);
  *
  * @param s  Corresponding format context.
  * @param st Stream from s to be checked.
- * @param spec A stream specifier of the [v|a|s|d]:[<stream index>] form.
+ * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
  *
  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
  */
diff --git a/libavcodec/cinepak.c b/libavcodec/cinepak.c
index 9cf38ed..08ab05f 100644
--- a/libavcodec/cinepak.c
+++ b/libavcodec/cinepak.c
@@ -22,10 +22,11 @@
 /**
  * @file
  * Cinepak video decoder
- * by Ewald Snel <ewald at rambo.its.tudelft.nl>
- * For more information on the Cinepak algorithm, visit:
+ * @author Ewald Snel <ewald at rambo.its.tudelft.nl>
+ *
+ * @see For more information on the Cinepak algorithm, visit:
  *   http://www.csse.monash.edu.au/~timf/
- * For more information on the quirky data inside Sega FILM/CPK files, visit:
+ * @see For more information on the quirky data inside Sega FILM/CPK files, visit:
  *   http://wiki.multimedia.cx/index.php?title=Sega_FILM
  */
 
diff --git a/libavcodec/eamad.c b/libavcodec/eamad.c
index 772fb28..c5aa6ac 100644
--- a/libavcodec/eamad.c
+++ b/libavcodec/eamad.c
@@ -22,9 +22,9 @@
 /**
  * @file
  * Electronic Arts Madcow Video Decoder
- * by Peter Ross <pross at xvid.org>
+ * @author Peter Ross <pross at xvid.org>
  *
- * Technical details here:
+ * @see technical details at
  * http://wiki.multimedia.cx/index.php?title=Electronic_Arts_MAD
  */
 
diff --git a/libavcodec/lsp.c b/libavcodec/lsp.c
index 834346b..2adc9cf 100644
--- a/libavcodec/lsp.c
+++ b/libavcodec/lsp.c
@@ -75,7 +75,7 @@ void ff_acelp_lsf2lspd(double *lsp, const float *lsf, int lp_order)
 
 /**
  * @brief decodes polynomial coefficients from LSP
- * @param f [out] decoded polynomial coefficients (-0x20000000 <= (3.22) <= 0x1fffffff)
+ * @param[out] f decoded polynomial coefficients (-0x20000000 <= (3.22) <= 0x1fffffff)
  * @param lsp LSP coefficients (-0x8000 <= (0.15) <= 0x7fff)
  */
 static void lsp2poly(int* f, const int16_t* lsp, int lp_half_order)
diff --git a/libavdevice/pulse.c b/libavdevice/pulse.c
index 7f7c6dc..bffe391 100644
--- a/libavdevice/pulse.c
+++ b/libavdevice/pulse.c
@@ -23,7 +23,6 @@
  * @file
  * PulseAudio input using the simple API.
  * @author Luca Barbato <lu_zero at gentoo.org>
- *
  */
 
 #include <pulse/simple.h>
diff --git a/libavdevice/x11grab.c b/libavdevice/x11grab.c
index 5673e5e..9d12b2f 100644
--- a/libavdevice/x11grab.c
+++ b/libavdevice/x11grab.c
@@ -31,8 +31,9 @@
 
 /**
  * @file
- * X11 frame device demuxer by Clemens Fruhwirth <clemens at endorphin.org>
- * and Edouard Gomez <ed.gomez at free.fr>.
+ * X11 frame device demuxer
+ * @author Clemens Fruhwirth <clemens at endorphin.org>
+ * @author Edouard Gomez <ed.gomez at free.fr>
  */
 
 #include "config.h"
diff --git a/libavformat/matroskadec.c b/libavformat/matroskadec.c
index 6fdad8b..b61c819 100644
--- a/libavformat/matroskadec.c
+++ b/libavformat/matroskadec.c
@@ -22,10 +22,10 @@
 /**
  * @file
  * Matroska file demuxer
- * by Ronald Bultje <rbultje at ronald.bitfreak.net>
- * with a little help from Moritz Bunkus <moritz at bunkus.org>
- * totally reworked by Aurelien Jacobs <aurel at gnuage.org>
- * Specs available on the Matroska project page: http://www.matroska.org/.
+ * @author Ronald Bultje <rbultje at ronald.bitfreak.net>
+ * @author with a little help from Moritz Bunkus <moritz at bunkus.org>
+ * @author totally reworked by Aurelien Jacobs <aurel at gnuage.org>
+ * @see specs available on the Matroska project page: http://www.matroska.org/
  */
 
 #include <stdio.h>
diff --git a/libavformat/oggdec.c b/libavformat/oggdec.c
index c22f2be..36e2c45 100644
--- a/libavformat/oggdec.c
+++ b/libavformat/oggdec.c
@@ -2,10 +2,9 @@
  * Ogg bitstream support
  * Luca Barbato <lu_zero at gentoo.org>
  * Based on tcvp implementation
- *
  */
 
-/**
+/*
     Copyright (C) 2005  Michael Ahlberg, Måns Rullgård
 
     Permission is hereby granted, free of charge, to any person
@@ -27,7 +26,7 @@
     WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
     DEALINGS IN THE SOFTWARE.
-**/
+ */
 
 
 #include <stdio.h>



More information about the ffmpeg-cvslog mailing list