Re: How to ensure that Boost option macros appear in the Doxygen generated index?

Kirit Sælensminde <[email protected]> Tue, 2 Feb 2016 10:09:00 +0700
Newsgroups gmane.comp.lib.boost.documentation
Message-ID <[email protected]>
On 02/02/16 01:13, Paul A. Bristow wrote:
> Can I force documentation of the macro symbol other than by nasty fudges like
>
>     #define BOOST_SOME_OPTION
>     #undef BOOST_SOME_OPTION
The way I always did this was to have a docs folder and put some extra 
.cpp and .hpp files in there that I gave to Doxygen but weren't included 
in the build. That way you can have whatever you need to get it to index 
things as you want without tainting your code.

I also found it a much more useful place to put longer explanations so I 
didn't clutter up all of the code with it (and didn't have to recompile 
when fixing typos etc.).


Kirit