misc Doxygen markup improvements
authorDiego Biurrun <diego@biurrun.de>
Sun, 30 Oct 2011 18:10:50 +0000 (19:10 +0100)
committerDiego Biurrun <diego@biurrun.de>
Mon, 5 Dec 2011 12:06:58 +0000 (13:06 +0100)
cmdutils.h
libavcodec/cinepak.c
libavcodec/eamad.c
libavcodec/lsp.c
libavdevice/pulse.c
libavdevice/x11grab.c
libavformat/matroskadec.c
libavformat/oggdec.c

index 55a06dd..fc438c7 100644 (file)
@@ -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 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
  */
  *
  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
  */
index 9cf38ed..08ab05f 100644 (file)
 /**
  * @file
  * Cinepak video decoder
 /**
  * @file
  * Cinepak video decoder
- * by Ewald Snel <ewald@rambo.its.tudelft.nl>
- * For more information on the Cinepak algorithm, visit:
+ * @author Ewald Snel <ewald@rambo.its.tudelft.nl>
+ *
+ * @see For more information on the Cinepak algorithm, visit:
  *   http://www.csse.monash.edu.au/~timf/
  *   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
  */
 
  *   http://wiki.multimedia.cx/index.php?title=Sega_FILM
  */
 
index 772fb28..c5aa6ac 100644 (file)
@@ -22,9 +22,9 @@
 /**
  * @file
  * Electronic Arts Madcow Video Decoder
 /**
  * @file
  * Electronic Arts Madcow Video Decoder
- * by Peter Ross <pross@xvid.org>
+ * @author Peter Ross <pross@xvid.org>
  *
  *
- * Technical details here:
+ * @see technical details at
  * http://wiki.multimedia.cx/index.php?title=Electronic_Arts_MAD
  */
 
  * http://wiki.multimedia.cx/index.php?title=Electronic_Arts_MAD
  */
 
index 834346b..2adc9cf 100644 (file)
@@ -75,7 +75,7 @@ void ff_acelp_lsf2lspd(double *lsp, const float *lsf, int lp_order)
 
 /**
  * @brief decodes polynomial coefficients from LSP
 
 /**
  * @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)
  * @param lsp LSP coefficients (-0x8000 <= (0.15) <= 0x7fff)
  */
 static void lsp2poly(int* f, const int16_t* lsp, int lp_half_order)
index 7f7c6dc..bffe391 100644 (file)
@@ -23,7 +23,6 @@
  * @file
  * PulseAudio input using the simple API.
  * @author Luca Barbato <lu_zero@gentoo.org>
  * @file
  * PulseAudio input using the simple API.
  * @author Luca Barbato <lu_zero@gentoo.org>
- *
  */
 
 #include <pulse/simple.h>
  */
 
 #include <pulse/simple.h>
index 5673e5e..9d12b2f 100644 (file)
@@ -31,8 +31,9 @@
 
 /**
  * @file
 
 /**
  * @file
- * X11 frame device demuxer by Clemens Fruhwirth <clemens@endorphin.org>
- * and Edouard Gomez <ed.gomez@free.fr>.
+ * X11 frame device demuxer
+ * @author Clemens Fruhwirth <clemens@endorphin.org>
+ * @author Edouard Gomez <ed.gomez@free.fr>
  */
 
 #include "config.h"
  */
 
 #include "config.h"
index 6fdad8b..b61c819 100644 (file)
 /**
  * @file
  * Matroska file demuxer
 /**
  * @file
  * Matroska file demuxer
- * by Ronald Bultje <rbultje@ronald.bitfreak.net>
- * with a little help from Moritz Bunkus <moritz@bunkus.org>
- * totally reworked by Aurelien Jacobs <aurel@gnuage.org>
- * Specs available on the Matroska project page: http://www.matroska.org/.
+ * @author Ronald Bultje <rbultje@ronald.bitfreak.net>
+ * @author with a little help from Moritz Bunkus <moritz@bunkus.org>
+ * @author totally reworked by Aurelien Jacobs <aurel@gnuage.org>
+ * @see specs available on the Matroska project page: http://www.matroska.org/
  */
 
 #include <stdio.h>
  */
 
 #include <stdio.h>
index c22f2be..36e2c45 100644 (file)
@@ -2,10 +2,9 @@
  * Ogg bitstream support
  * Luca Barbato <lu_zero@gentoo.org>
  * Based on tcvp implementation
  * Ogg bitstream support
  * Luca Barbato <lu_zero@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
     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.
     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>
 
 
 #include <stdio.h>