Re: [boost] [tweener] Doxygen documentation issues

Subject: Re: [boost] [tweener] Doxygen documentation issues
From: Steven Watanabe (watanabesj_at_[hidden])
Date: 2013-11-05 13:22:55

AMDG

On 11/05/2013 10:10 AM, Paul A. Bristow wrote:
> 
>> Doxygen XML is a bit annoying about that.  Last time I tried, it seemed to ignore the option
> that's
>> supposed to hide private members.  What we usually use is
>> /** INTERNAL ONLY */ which will cause BoostBook to strip it out.
> 
> I've added this in all the namespace detail section and this is effective at reducing the items that
> are in the C++ reference section (from Quickbook).
> 
> This is what a typical *user* wants - the implementation stuff in namespace detail (for example) is
> just clutter.
> 
> But an *author or maintainer* might want all the detail sections included in the C++ reference
> section.
> 
> I can achieve this by horribly hacking the *.*pp files to change all INTERNAL ONLY to INTERNAL AS
> WELL - or something.
> 
> Can you suggest a better way of switching this INTERNAL ONLY feature on/off?
> 

These days, I use \cond show_private instead.

In Christ,
Steven Watanabe