Boost logo

Boost :

Subject: Re: [boost] [tweener] Doxygen documentation issues
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2013-11-05 13:10:47


> -----Original Message-----
> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of Steven Watanabe
> Sent: Wednesday, February 27, 2013 4:48 AM
> To: boost_at_[hidden]
> Subject: Re: [boost] [tweener] Doxygen documentation issues
>
> AMDG
> how can I also disable the extraction of the private members in the documentation?
> >
>
> 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?

Thanks

Paul

---
Paul A. Bristow,
Prizet Farmhouse, Kendal LA8 8AB  UK
+44 1539 561830  07714330204
pbristow_at_[hidden]

Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk