Re: [Doxygen-users] suppress title/lead-in for multiple instances of (aliased) custom commands for \par ?

[Christoph L. <chr...@li...>]

If you can do without the introductory text ("To enable this function,
the following preprocessor directives must be defined"), the \xrefitem
command may be the way to go:

ALIASES = preprocess=”\xrefitem preprocess \"Required Preprocessor
Directives\" \"Conditional Compilation\" \n+ \c“

Note that this has the side effect of generating an additional page with
all of the conditional compilation stuff (titled "Conditional
Compilation" in the above example), like you get with the "\todo"
command; this may or may not be considered a benefit.


Am 19.08.2015 um 22:15 schrieb Monique Semp:
> Hello, Doxygen users,
>  
> I’m using Doxygen 1.8.10 on Mac OS X 10.10.3 (Yosemite).
>  
> Summary:
>  
> I created an alias to use for listing preprocessor directives that are
> required to be defined in order to enable the function that’s being
> documented. The alias is to the \par command so that I can have a
> custom heading and lead-in paragraph, and then the specified compiler
> directive. This all works great when there’s only a single directive
> required for a function, but when there are multiple directives, I
> haven’t figured out how to consolidate the output into a single
> heading/intro text/list.
>  
> Details:
>  
> Here’s the code I added to the Doxyfile:
>  
> ALIASES = preprocess=”\par Preprocessor Directives\nTo enable this
> function, the following preprocessor directives must be defined:\n+ \c “
>  
> This works wonderfully when I have just a single directive specified
> in the function’s comment block as “@preprocess __FLAG1__”. The output
> is a bold heading, “Preprocessor Directives”, then the explanation on
> the next line, and finally the __FLAG1__ listed in code font as a
> bullet point.
>  
> But... If if use a 2nd @preprocess command in a single function’s
> comments, the 2nd flag has the heading and intro text again. And of
> course what I want is a single heading/intro and then a consolidated
> list of the all the function’s @preprocess flags.
>  
> I’ve tried adding the \parblock, \endparblock commands to the function
> comment block, but that didn’t have any effect. Perhaps I could do
> this by overloading the @preprocess command with aliases defined for
> 1, 2, 3, etc. arguments. But I’d eventually be stuck, I’m sure, with a
> function that requires more flags than however many arguments I’d defined.
>  
> Any suggestions as to how to implement this?
>  
> Thanks very much,
> -Monique
>  
>
>
> ------------------------------------------------------------------------------
>
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users