diff options
| author | Diego Biurrun <diego@biurrun.de> | 2011-07-04 12:33:11 +0200 |
|---|---|---|
| committer | Diego Biurrun <diego@biurrun.de> | 2011-07-14 04:09:50 +0200 |
| commit | d0fcf39f0c6201c8cce439395eee051798c0a958 (patch) | |
| tree | 32a10116a34a2d0af590ced889edc113c5f462f2 | |
| parent | 96c1e6d40d389eeb628840030dfe340d762a7ac8 (diff) | |
| download | ffmpeg-d0fcf39f0c6201c8cce439395eee051798c0a958.tar.gz | |
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.
| -rw-r--r-- | Doxyfile | 3 | ||||
| -rw-r--r-- | libavcodec/aacps.c | 24 |
2 files changed, 14 insertions, 13 deletions
@@ -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 d818790a6f..03d0beabdd 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) \ { \ |