Boost logo

Boost :

From: Tobias Schwinger (tschwinger_at_[hidden])
Date: 2005-06-10 07:18:51


Jody Hagins wrote:
> On Wed, 08 Jun 2005 16:06:17 +0200
> Tobias Schwinger <tschwinger_at_[hidden]> wrote:
>
>
>
>>I did document them "just in case", because there might be some
>>corner-cases in which their use is more efficient or convenient. It
>>seems safe to remove them from the documentation to me ITM, but I
>>want to think some more about it before doing so. Another option
>>could be to move their description to a comment in the header.
>>
>>If they are kept, however, I see the documentation should be changed
>>to make a very clear recommendation not to use them, unless having
>>good reasons.
>>
>
>
> I think the question is not of whether they should be documented, but
> whether they should be exposed. If they are exposed, then they should
> be documented. If you do not want them to be used, then protect them,
> or put them in the detail namespace.

I can't really say: "I want noone to use this", here. All I can say is "do not
use unless you're sure you need it".
I've added a note to the documentation that this class is a "white box", however.

Regards,

Tobias


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