RE: [Doxygen-develop] Macroized Functions

[Michael M. <Mic...@tt...>]

Hi Duane,

I made a patch to allow \def to be used to force documentation of a define,
even if the #define is not found in the source code.  It was for a similar
problem that I made this mod.

I reported it as a bug in Bugzilla, and the patch for 1.4.3 is attached to
that.  See "Bug 310895: Cannot document non-existant defines with \def".
Maybe this could be a help to you?

Regards,

Mike

> -----Original Message-----
> From: dox...@li... [mailto:doxygen-develop-
> ad...@li...] On Behalf Of Duane Ellis
> Sent: 13 October 2005 17:50
> To: dox...@li...
> Subject: [Doxygen-develop] Macroized Functions
> 
> We are using doxygen to document some C code for a bios.
> 
> Hundreds of functions are defined via macros. For example:
> 
> /** Set the platform RTC Clock to specified time (TZ=GMT)
> * \param p_date - Pointer to the date
> * \return  TRUE success, FALSE error (platform lacks RTC)
> */
> TRAPFUNC(   BOOL,  biosRtcSetGMT,   ( RTC_DATE *p_data ) );
> 
> The problem is the "TRAPFUNC" macro. The "trapfunc" macro creates multiple
> 
> instances of the function name - addorned with attributes and does ohter
> things.
> (the same header file is compiled in multiple ways) {It simplifies many
> many things
> We really don't want to change that.}
> 
> I've tried:
> 
> #ifdef DOXYGEN
> #define TRAPCALL( X, Y, Z )      X Y Z
> #endif
> 
> but that does not help, doxygen does not expand #defines.
> 
> Doing #ifdef DOXYGEN blocks around hundreds of API function is *NOT* a
> good idea.
> 
> Any suggestions?
> 
> -Duane.
> 
> 
> 
> 
> 
> -------------------------------------------------------
> This SF.Net email is sponsored by:
> Power Architecture Resource Center: Free content, downloads, discussions,
> and more. http://solutions.newsforge.com/ibmarch.tmpl
> _______________________________________________
> Doxygen-develop mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-develop