Re: [Boost-docs] Preventing private member functions from appearing in the doxygen reference info

Subject: Re: [Boost-docs] Preventing private member functions from appearing in the doxygen reference info
From: Vicente J. Botet Escriba (vicente.botet_at_[hidden])
Date: 2011-12-10 09:09:57

Le 09/12/11 10:28, Paul A. Bristow a écrit :
>
>> -----Original Message-----
>> From: boost-docs-bounces_at_[hidden] [mailto:boost-docs-bounces_at_[hidden]] On Behalf Of
>> Vicente J. Botet Escriba
>> Sent: Thursday, December 08, 2011 10:33 PM
>> To: Discussion of Boost Documentation
>> Subject: Re: [Boost-docs] Preventing private member functions from appearing in the doxygen
> reference
>> info
>>
>> Le 08/12/11 19:59, Paul A. Bristow a écrit :
>>> I'm struggling to stop private member functions from appearing in the
>>> Doxygen reference section of Quickbook generated stuff.
>>>
>>> private member functions do not appear in the Standalone Doxygen docs,
>>> and I've tried to set the corresponding<doxygen:param>   settings in the jamfile.
>>>
>>> <doxygen:param>EXTRACT_ALL=NO
>>>       <doxygen:param>EXTRACT_PRIVATE=NO
>>>       <doxygen:param>EXTRACT_STATIC=NO<doxygen:param>HIDE_UNDOC_MEMBERS=YES
>>>    <doxygen:param>HIDE_UNDOC_MEMBERS=YES
>>>    <doxygen:param>HIDE_UNDOC_CLASSES=YES
>>>
>>> but I'm still getting the private members listed.
>>>
>>> Please can anyone confirm that they have seen this working as expected, supressing private
> members?
>>> (This will confirm that I am missing something).
>>>
>>> Or any others suggestions on tracing this?
>>>
>> Hi,
>>
>> It ois working for me with
>>   >  quickbook --version
>> Quickbook Version 1.5.4
>>
>> I use
>>
>> <doxygen:param>SORT_MEMBER_DOCS=NO
>> <doxygen:param>SHOW_USED_FILES=YES
>>
>> <doxygen:param>SHOW_INCLUDE_FILES=YES
>> <doxygen:param>WARNINGS=YES # Default NO, but useful to see warnings, especially in a logfile.
>>           # It is also wise to to set a warnings logfile like this:
>> <doxygen:param>WARN_LOGFILE=AutoDoxywarnings.log # This may not be empty (usually not a good
>> sign!), depending on options chosen.
>>           # Much better to send message to a logfile than the default stderr.
>>           # and make sure that there are no Doxygen errors or significant warnings in the log file.
>> <doxygen:param>RECURSIVE=NO # Search recursively down subdirectories.
>> <doxygen:param>EXTRACT_ALL=YES
>> <doxygen:param>ENABLE_PREPROCESSING=YES
>> <doxygen:param>MACRO_EXPANSION=YES
>> <doxygen:param>HIDE_UNDOC_MEMBERS=NO
>> <doxygen:param>EXTRACT_PRIVATE=NO
>> <doxygen:param>EXPAND_ONLY_PREDEF=YES
>> <doxygen:param>SEARCH_INCLUDES=YES
>> <doxygen:param>INCLUDE_PATH=$(BOOST)
> That looks the same as I am using to me, but I'll re-recheck.
>
>> Which version are you using?
> Doxygen 1.7.6 - latest.
>
> Current Quickbook 1.5 (not dev branch).
>
> But can you confirm that private members really are excluded from the html Doxygen prepared
> reference section?
>
> (My private member functions are NOT showing the Standalone Doxygen docs).
>
> If you can confirm you are supressing private member function, then I know that I am wrong
> somewhere.  (Always the most like explanation :-(  )
>
Private member functions are not generated as well as members in the 
detail namespace.

Using doxigen 1.7.3

Vicente