Re: [boost] Subject: Formal Review of Proposed Boost.Process library starts tomorrow

Subject: Re: [boost] Subject: Formal Review of Proposed Boost.Process library starts tomorrow
From: Vicente Botet (vicente.botet_at_[hidden])
Date: 2011-02-08 00:50:20

Steven Watanabe-4 wrote:
> 
> AMDG
> 
> On 2/7/2011 11:09 AM, Vicente Botet wrote:
>>
>> private functions like invalid_handle don't need to be documented.
>> Shouldn't
>> the nested impl class be private?
>>
> 
> impl is private.  I usually wrap private members
> in \cond \endcond to avoid this.  It should probably
> be fixed in the doxygen to boostbook conversion, however.
> 

There are no \cond \endcond on the code. Doesn't Doxigen have a generation
flag to state which level is documented?

> [pistream/postream]
> class pistream : public std::istream, public boost::noncopyable
>
> * inheritance missing on the documentation.

It's lost by doxygen.  I don't know whether there's an
easy way to fix it.

Maybe we need to include a specific forward declaration file while building
the documentation with Doxigen?

> * constructor must be documented explicit
>

Fixed in trunk BoostBook.

It would be great if we had a wiki page on which we state explicitly all the
limitation and good usage of Doxigen.

Thanks,
Vicente
-- 
View this message in context: http://boost.2283326.n4.nabble.com/Subject-Formal-Review-of-Proposed-Boost-Process-library-starts-tomorrow-tp3263607p3270826.html
Sent from the Boost - Dev mailing list archive at Nabble.com.