Re: [Doxygen-develop] Re: [Doxygen-users] Making an Easy and fast readable C Library Manual reference.(TODO-Suggestions)

[Dimitri v. H. <di...@st...>]

On Tue, Nov 20, 2001 at 07:05:56PM +0100, Toni Moreno Giménez wrote:
> El Mar 20 Nov 2001 06:25, Dean Povey escribió:
> > <snip>
> >
> > Let me add a big ditto to most of this.  Doxygen is great, but I find it
> > is almost, but not quite there for documenting C code.
> >
> > >2) * hide Macro definitions body. ( and document them like functions )
> >
> > You can hide macro body with @hideinitializer.  It would be good to be able
> 
> /** \def GSDATAFORMAT_GET_FORMAT_WITHOUT_ENDIANES
> *       \hideinitializer
> */
> 
> the outputs is....
> 
>  #define GSDATAFORMAT_GET_FORMAT_WITHOUT_ENDIANES( __fmt ) 
> Value:({ register guint __v;                                          \
>          if ( (((__fmt) & FORMAT_BYTEORDER_LE)>>4) ^                    \
>               (((__fmt) & FORMAT_BYTEORDER_BE)>>5) )                    \
>          __v=((__fmt) & ~GSDATAFORMAT_BYTEORDER_MASK);                  \
>          else __v=(__fmt);                                              \
>          __v;                                                           \
>          })
> 
> I CAN'T HIDE MACRO BODY.... 

Then you are doing something wrong!

Using:

/** \file */

/** Docs here.
 *  \hideinitializer 
 */
#define GSDATAFORMAT_GET_FORMAT_WITHOUT_ENDIANES( __fmt )             \
      ({ register guint __v;                                          \
       if ( (((__fmt) & FORMAT_BYTEORDER_LE)>>4) ^                    \
         (((__fmt) & FORMAT_BYTEORDER_BE)>>5) )                       \
       __v=((__fmt) & ~GSDATAFORMAT_BYTEORDER_MASK);                  \
       else __v=(__fmt);                                              \
       __v;                                                           \
       })

/*! An enum */
typedef enum
{
  val = 10 /*!< \hideinitializer enum value */
} MyEnum;

With a default config file, I get no initializer for defines or enums.

If you get tired of typing \hideinitializer, then set
MAX_INITIALIZER_LINES to 0 to hide all initializers
automatically and use \showinitializer at those place
where values are needed. 

Regards,
  Dimitri