Re: [boost] [docbook] Add detail namespace to Reference section

Subject: Re: [boost] [docbook] Add detail namespace to Reference section
From: Rob Stewart (robertstewart_at_[hidden])
Date: 2014-08-16 10:11:05

On August 16, 2014 10:06:05 AM EDT, Benedek Thaler <thalerbenedek_at_[hidden]> wrote:
>On Sat, Aug 16, 2014 at 4:00 PM, Rob Stewart
><robertstewart_at_[hidden]>
>wrote:
>
>> I don't know how to make it appear, but the real question is why you
>> would want to document an implementation detail.
>>
>As shown in the example, the class to be documented is lifted to the
>public
>namespace. Real code:
>https://github.com/erenon/pipeline/blob/master/include/boost/pipeline/type_erasure.hpp#L358
>
>It can't be in the public namespace because related operators are in
>the
>detail namespace which also serve other classes in the that namespace.

If you're lifting them into the public namespace, they aren't implementation details. Choose another name for the namespace with those identifiers and keep only implementation details in the detail namespace.

___
Rob

(Sent from my portable computation engine)