Browse code

misc Doxygen markup improvements

Diego Biurrun authored on 2011/10/31 03:10:50
Showing 8 changed files
... ...
@@ -190,7 +190,7 @@ void parse_loglevel(int argc, char **argv, const OptionDef *options);
190 190
  *
191 191
  * @param s  Corresponding format context.
192 192
  * @param st Stream from s to be checked.
193
- * @param spec A stream specifier of the [v|a|s|d]:[<stream index>] form.
193
+ * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
194 194
  *
195 195
  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
196 196
  */
... ...
@@ -22,10 +22,11 @@
22 22
 /**
23 23
  * @file
24 24
  * Cinepak video decoder
25
- * by Ewald Snel <ewald@rambo.its.tudelft.nl>
26
- * For more information on the Cinepak algorithm, visit:
25
+ * @author Ewald Snel <ewald@rambo.its.tudelft.nl>
26
+ *
27
+ * @see For more information on the Cinepak algorithm, visit:
27 28
  *   http://www.csse.monash.edu.au/~timf/
28
- * For more information on the quirky data inside Sega FILM/CPK files, visit:
29
+ * @see For more information on the quirky data inside Sega FILM/CPK files, visit:
29 30
  *   http://wiki.multimedia.cx/index.php?title=Sega_FILM
30 31
  */
31 32
 
... ...
@@ -22,9 +22,9 @@
22 22
 /**
23 23
  * @file
24 24
  * Electronic Arts Madcow Video Decoder
25
- * by Peter Ross <pross@xvid.org>
25
+ * @author Peter Ross <pross@xvid.org>
26 26
  *
27
- * Technical details here:
27
+ * @see technical details at
28 28
  * http://wiki.multimedia.cx/index.php?title=Electronic_Arts_MAD
29 29
  */
30 30
 
... ...
@@ -75,7 +75,7 @@ void ff_acelp_lsf2lspd(double *lsp, const float *lsf, int lp_order)
75 75
 
76 76
 /**
77 77
  * @brief decodes polynomial coefficients from LSP
78
- * @param f [out] decoded polynomial coefficients (-0x20000000 <= (3.22) <= 0x1fffffff)
78
+ * @param[out] f decoded polynomial coefficients (-0x20000000 <= (3.22) <= 0x1fffffff)
79 79
  * @param lsp LSP coefficients (-0x8000 <= (0.15) <= 0x7fff)
80 80
  */
81 81
 static void lsp2poly(int* f, const int16_t* lsp, int lp_half_order)
... ...
@@ -23,7 +23,6 @@
23 23
  * @file
24 24
  * PulseAudio input using the simple API.
25 25
  * @author Luca Barbato <lu_zero@gentoo.org>
26
- *
27 26
  */
28 27
 
29 28
 #include <pulse/simple.h>
... ...
@@ -31,8 +31,9 @@
31 31
 
32 32
 /**
33 33
  * @file
34
- * X11 frame device demuxer by Clemens Fruhwirth <clemens@endorphin.org>
35
- * and Edouard Gomez <ed.gomez@free.fr>.
34
+ * X11 frame device demuxer
35
+ * @author Clemens Fruhwirth <clemens@endorphin.org>
36
+ * @author Edouard Gomez <ed.gomez@free.fr>
36 37
  */
37 38
 
38 39
 #include "config.h"
... ...
@@ -22,10 +22,10 @@
22 22
 /**
23 23
  * @file
24 24
  * Matroska file demuxer
25
- * by Ronald Bultje <rbultje@ronald.bitfreak.net>
26
- * with a little help from Moritz Bunkus <moritz@bunkus.org>
27
- * totally reworked by Aurelien Jacobs <aurel@gnuage.org>
28
- * Specs available on the Matroska project page: http://www.matroska.org/.
25
+ * @author Ronald Bultje <rbultje@ronald.bitfreak.net>
26
+ * @author with a little help from Moritz Bunkus <moritz@bunkus.org>
27
+ * @author totally reworked by Aurelien Jacobs <aurel@gnuage.org>
28
+ * @see specs available on the Matroska project page: http://www.matroska.org/
29 29
  */
30 30
 
31 31
 #include <stdio.h>
... ...
@@ -2,10 +2,9 @@
2 2
  * Ogg bitstream support
3 3
  * Luca Barbato <lu_zero@gentoo.org>
4 4
  * Based on tcvp implementation
5
- *
6 5
  */
7 6
 
8
-/**
7
+/*
9 8
     Copyright (C) 2005  Michael Ahlberg, Måns Rullgård
10 9
 
11 10
     Permission is hereby granted, free of charge, to any person
... ...
@@ -27,7 +26,7 @@
27 27
     WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28 28
     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29 29
     DEALINGS IN THE SOFTWARE.
30
-**/
30
+ */
31 31
 
32 32
 
33 33
 #include <stdio.h>