Re: [Boost-docs] Help with Doxygen and Boost

Subject: Re: [Boost-docs] Help with Doxygen and Boost
From: Vicente J. Botet Escriba (vicente.botet_at_[hidden])
Date: 2014-09-12 18:14:47

Le 12/09/14 16:57, Renato Forti a écrit :
>
> Hi All,
>
>
> I have one problem in docs generation (doxygen), if anyone can help me.
>
> I used this to hide my ‘private’ methods of docs reference :
>
>
> <doxygen:param>EXTRACT_PRIVATE=NO
>
>
> But this don’t work, if you check the generated docs, you will see 
> that docs shows the private method (check for get_impl):
>
>
> http://apolukhin.github.io/Boost.DLL/boost/dll/shared_library.html#idp6341792-bb
>
>
> I tried adding this too:
>
>
> <doxygen:param>HIDE_UNDOC_MEMBERS=YES
>
> <doxygen:param>HIDE_UNDOC_CLASSES=YES
>
> <doxygen:param>HIDE_SCOPE_NAMES=YES
>
> <doxygen:param>EXTRACT_ALL=NO
>
>
> But don’t work!
>
Hi Renato,

I don't master the settings.
I suggest you to copy/paste e.g. the jamfile of Boost.Container. Try 
however to generate first the documentation of Boost.Container.

Next follows the settings used in this file.

<doxygen:param>EXTRACT_ALL=NO
<doxygen:param>HIDE_UNDOC_MEMBERS=YES
<doxygen:param>EXTRACT_PRIVATE=NO
<doxygen:param>ENABLE_PREPROCESSING=YES
<doxygen:param>EXPAND_ONLY_PREDEF=YES
<doxygen:param>MACRO_EXPANSION=YES

HTH,
Vicente