doxygen: Move function documentation into the macro generating the function.
authorDiego Biurrun <diego@biurrun.de>
Mon, 4 Jul 2011 10:33:11 +0000 (12:33 +0200)
committerDiego Biurrun <diego@biurrun.de>
Thu, 14 Jul 2011 02:09:50 +0000 (04:09 +0200)
This fixes a bunch of related warnings where Doxygen assumed that the
documentation belonged to the macro and not the function.

Doxyfile
libavcodec/aacps.c

index a4beaba..bb8d92b 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -1382,7 +1382,8 @@ PREDEFINED             = "__attribute__(x)=" \
 # The macro definition that is found in the sources will be used.
 # Use the PREDEFINED tag if you want to use a different macro definition.
 
-EXPAND_AS_DEFINED      = declare_idct
+EXPAND_AS_DEFINED      = declare_idct  \
+                         READ_PAR_DATA \
 
 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
 # doxygen's preprocessor will remove all function-like macros that are alone
index d818790..03d0bea 100644 (file)
@@ -69,19 +69,19 @@ static const int huff_iid[] = {
 
 static VLC vlc_ps[10];
 
-/**
- * Read Inter-channel Intensity Difference/Inter-Channel Coherence/
- * Inter-channel Phase Difference/Overall Phase Difference parameters from the
- * bitstream.
- *
- * @param avctx contains the current codec context
- * @param gb    pointer to the input bitstream
- * @param ps    pointer to the Parametric Stereo context
- * @param PAR   pointer to the parameter to be read
- * @param e     envelope to decode
- * @param dt    1: time delta-coded, 0: frequency delta-coded
- */
 #define READ_PAR_DATA(PAR, OFFSET, MASK, ERR_CONDITION) \
+/** \
+ * Read Inter-channel Intensity Difference/Inter-Channel Coherence/ \
+ * Inter-channel Phase Difference/Overall Phase Difference parameters from the \
+ * bitstream. \
+ * \
+ * @param avctx contains the current codec context \
+ * @param gb    pointer to the input bitstream \
+ * @param ps    pointer to the Parametric Stereo context \
+ * @param PAR   pointer to the parameter to be read \
+ * @param e     envelope to decode \
+ * @param dt    1: time delta-coded, 0: frequency delta-coded \
+ */ \
 static int read_ ## PAR ## _data(AVCodecContext *avctx, GetBitContext *gb, PSContext *ps, \
                         int8_t (*PAR)[PS_MAX_NR_IIDICC], int table_idx, int e, int dt) \
 { \