[FFmpeg-cvslog] r23988 - trunk/libavcodec/lcldec.c

[Diego Biurrun]

On Fri, Jul 02, 2010 at 01:44:00PM +0100, M?ns Rullg?rd wrote:
> diego <subversion at mplayerhq.hu> writes:
> >
> > Log:
> > Move #ifdef before zlib_decomp() up so it covers the Doxygen comments.
> > Otherwise Doxygen gets confused and cannot map comments to functions.
> >
> > --- trunk/libavcodec/lcldec.c	Fri Jul  2 14:35:51 2010	(r23987)
> > +++ trunk/libavcodec/lcldec.c	Fri Jul  2 14:41:07 2010	(r23988)
> > @@ -117,6 +117,7 @@ static unsigned int mszh_decomp(const un
> >
> > +#if CONFIG_ZLIB_DECODER
> >  /**
> >   * \brief decompress a zlib-compressed data block into decomp_buf
> >   * \param src compressed input buffer
> > @@ -124,7 +125,6 @@ static unsigned int mszh_decomp(const un
> >   * \param offset offset in decomp_buf
> >   * \param expected expected decompressed length
> >   */
> > -#if CONFIG_ZLIB_DECODER
> >  static int zlib_decomp(AVCodecContext *avctx, const uint8_t *src, int src_len, int offset, int expected)
> 
> Are you sure this really fixes it?  Doxygen runs the file through the
> C preprocessor, and CONFIG_ZLIB_DECODER is probably not set there.
> This change simply hides both the documentation and the function.

AFAICT keeping both function and doxy #ifdeffed as one block is the
only way to avoid Doxygen getting terribly confused.

> To get everything included, we should probably create a special
> config.h for doxygen with all options enabled, even otherwise
> impossible combinations.

Possibly...

Diego