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

[Toni M. <ton...@wa...>]

El Mar 20 Nov 2001 06:25, Dean Povey escribi=F3:
> <snip>
>
> Let me add a big ditto to most of this.  Doxygen is great, but I find i=
t
> 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 )=20
Value:({ register guint __v;                                          \
         if ( (((__fmt) & FORMAT_BYTEORDER_LE)>>4) ^                    \
              (((__fmt) & FORMAT_BYTEORDER_BE)>>5) )                    \
         __v=3D((__fmt) & ~GSDATAFORMAT_BYTEORDER_MASK);                 =
 \
         else __v=3D(__fmt);                                             =
 \
         __v;                                                           \
         })

I CAN'T HIDE MACRO BODY....=20

> to add information about the type of macro parameters and expected retu=
rns
> where relevant.  Also it would be nice to be able to abstract the fact =
that
> a macro is a macro and not a function, as sometimes you want to switch
> between functions and macros.

The internal designs don't let me do so.

if you see this.

#define GSDATAFORMAT_GET_FORMAT_WITHOUT_ENDIANES( __fmt )=20
	__fmt : a format enum
	macro returns:  the same format without endiantes format info.

you are completely sure that your are using a Macro not a function.


--=20
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
Toni Moreno Gim=E9nez
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
Pje de las rosas  n=BA 22
Vilassar de Mar=20
(Barcelona) Espa=F1a
CP: 08340