On Fri, Feb 01, 2002 at 11:36:22AM +0000, Simon A Watts wrote:
> I have been using Doxygen on a diverse project, and incorporated it into
> our build process. Once limitation I have encountered is in the control
> of which pre-processor macros should be expanded.
>
> Currently we have to specify in the Doxygen configuration file which
> macros should be expanded when generating the docs, unless an
> all-or-nothing approach is used.
>
> But, we have a general config file for a series of sub-projects.
>
> What would be nice is if there could be a command, associated with the
> documentation for a macro, to say whether that macro should be expanded
> or not. Something like:
>
> /// @expand
> #define MYMACRO(ARG1,ARG2) ...
>
> /// @noexpand
> #define KEY_SIZE 123
>
>
> If this was the case, I'd probably set Doxygen not to expand anything by
> default, and just expand what I've requested (which would mostly be
> code-generating macros in my case).
I've added it to my todo list.
> Of course, I could instigate this now by using using "grep" on the
> source files (since make already explicitly accumulates a list of the
> source files), and append to the EXPAND_AS_DEFINED config option.
> Though for that I'd have to use "/// @expand MYMACRO(ARG1,ARG2)" type
> syntax instead.
If you create a small perl script that looks at two lines, I think just
using @expand with arguments would do too.
Regards,
Dimitri
|
