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

Subject: Re: [Boost-docs] How to ensure that Boost option macros appear in the Doxygen generated index?
From: Kirit Sælensminde (kirit.saelensminde_at_[hidden])
Date: 2016-02-02 03:09:00


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


This archive was generated by hypermail 2.1.7 : 2017-11-11 08:50:41 UTC