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

Subject: Re: [Boost-docs] Help with Doxygen and Boost
From: Renato Forti (rtforti_at_[hidden])
Date: 2014-09-13 13:51:13

Hi Vicente,

Thanks for your suggestion, well I have same problem in docs generation of
‘container’.

If you check, for instance, the code of ‘vector’ you will note that private
sections is wrapped by 'BOOST_CONTAINER_DOXYGEN_INVOKED':

#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED

private:

BOOST_COPYABLE_AND_MOVABLE(vector)

typedef container_detail::vector_value_traits<value_type, Allocator>
value_traits;

typedef container_detail::integral_constant<unsigned, 0> allocator_v0;

typedef container_detail::integral_constant<unsigned, 1> allocator_v1;

typedef container_detail::integral_constant<unsigned, 2> allocator_v2;

typedef constant_iterator<T, difference_type>            cvalue_iterator;

#endif   //#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED

https://github.com/boostorg/container/blob/master/include/boost/container/vector.hpp#L579

Note that in version 1.54: “/// @cond” and “/// @endcond”, is used instead
macro: “BOOST_CONTAINER_DOXYGEN_INVOKED”.

Thus any code 'wrapped' is excluded from documentation. This appears
strange to me, anyone know if this is a workaround? And why
'<doxygen:param>EXTRACT_PRIVATE=NO' do not work here?

Thanks for help!

2014-09-12 15:14 GMT-03:00 Vicente J. Botet Escriba <
vicente.botet_at_[hidden]>:

> 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
>
>
> _______________________________________________
> Boost-docs mailing list
> Boost-docs_at_[hidden]
> http://lists.boost.org/mailman/listinfo.cgi/boost-docs
>