[FFmpeg-cvslog] doxygen: Move function documentation into the macro generating the function .

[Diego Biurrun]

ffmpeg | branch: master | Diego Biurrun <diego at biurrun.de> | Mon Jul  4 12:33:11 2011 +0200| [d0fcf39f0c6201c8cce439395eee051798c0a958] | committer: Diego Biurrun

doxygen: Move function documentation into the macro generating the function.

This fixes a bunch of related warnings where Doxygen assumed that the
documentation belonged to the macro and not the function.

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

 Doxyfile           |    3 ++-
 libavcodec/aacps.c |   24 ++++++++++++------------
 2 files changed, 14 insertions(+), 13 deletions(-)

diff --git a/Doxyfile b/Doxyfile
index a4beaba..bb8d92b 100644
--- 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
diff --git a/libavcodec/aacps.c b/libavcodec/aacps.c
index d818790..03d0bea 100644
--- a/libavcodec/aacps.c
+++ b/libavcodec/aacps.c
@@ -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) \
 { \