Re: [Doxygen-users] documenting multiple methods defined by a single macro - help

[<mx...@se...>]

Manfred Doudar wrote:

> mx...@se... wrote:
> 
>>
>> You get evidently the macro not expanded, which means you have bad 
>> setup in some way.
>>
>> * maybe you want to expand even the macros BOOST_PP_REPEAT 
>> BOOST_PP_INC RESHAPE_DIM_MAX etc.
>> (EXPAND_AS_DEFINED      = RESHAPE BOOST_PP_REPEAT BOOST_PP_INC 
>> RESHAPE_DIM_MAX)
> 
> 
> 
> that seems like a reasonable proposition at first, but wouldn't that 
> mean having to `@def` the macros BOOST_PP_REPEAT and BOOST_PP_INC in the 
>  files they are defined?
> 
> -if that's the case, then it's problematic ... because the PP_REPEAT, 
> PP_INC are third party [C++ Boost library] macros, and it certainly 
> would be a bad idea to doxygenize the Boost library sources; that'd be a 
> maintenance nightmare at the very least (especially considering periodic 
> updates to the Boost libs).
> 

The point is, that if you include the Boost library headers (where the 
macros BOOST_PP_REPEAT and BOOST_PP_INC are defined, you *really* need 
it to get the macro expansion work) in "INCLUDE_PATH", that is only for 
macro search and expansion purposes (better said for preprocessor 
purposes), and these sources *will not be doxygenized* (if you not 
include these paths in "INPUT" locations too, of course).

(the Doxygen documentation says following about the INCLUDE_PATH:
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by
# the preprocessor.)


* hint: if you have some environment variable defined to point to Boost 
library location, you can use this environment variable as e.g.
INCLUDE_PATH = $(WXWIN)/include/wx
(this works fine for me)