Re: [boost] [tweener] Doxygen documentation issues

Subject: Re: [boost] [tweener] Doxygen documentation issues
From: Steven Watanabe (watanabesj_at_[hidden])
Date: 2013-02-26 23:47:53

AMDG

On 02/26/2013 01:28 PM, Julien Jorge wrote:
> Hi,
>         
> I am writing the documentation of Boost.Tweener and I encounter various
> difficulties. One of them is the generation of the class documentation
> with doxygen. It seems that it cannot extract the class and member
> documentation from .ipp files.
>         
> I like to document the methods of my classes near the implementation. In
> Boost.Tweener, most of the class documentation is then in the .ipp files
> and I have written the following lines in the Jamfile.v2:
>         
> <snip>
>         
> But when I try to build the documentation, I have the following error:
>         
>   boost_1_52_0/tools/build/v2/build/generators.jam:1085: in ensure-type
>     from module generators
>   error: target
>     { ../../../boost/tweener/detail/impl/tweener_group.ipp. }
>     has no type
>         

I can fix this globally, but for now, the easiest fix is:

import type ;
type.register-suffixes ipp : HPP ;

> Moreover, if I remove the ipp files, the generation of the documentation
> does not fail but the doxygen documentation is not extracted, except for
> the private members. So, 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.

In Christ,
Steven Watanabe