Re: [boost] [convert] incomplete reference documentation

Subject: Re: [boost] [convert] incomplete reference documentation
From: Edward Diener (eldiener_at_[hidden])
Date: 2011-04-06 11:11:32

On 4/6/2011 3:09 AM, Vicente BOTET wrote:
>
>
>
>> Message du 06/04/11 03:44
>> De : "Edward Diener"
>> A : boost_at_[hidden]
>> Copie à :
>> Objet : Re: [boost] [convert] incomplete reference documentation
>>
>> On 4/5/2011 7:18 PM, Vicente BOTET wrote:
>>> Hi,
>>>
>>> I was taking a look at the documentation and it seems to me that the reference documentation is incomplete and not ready for review. Do you plan to complete it before review?
>>
>> Do you have the latest version from the Vault ?
>
> I downloaded it yesterday. The doc has this date
> Last revised: March 02, 2011 at 22:33:53 GMT
>
>> Don't you think you should say what you feel is incomplete about it ?
>
> Well, I would prefer the author checks it. I suspect that the documentation is generated with doxygen, and we must be quite careful to ensure all the public parts are documented.

I think in the doc only tha main class is documented in the reference 
section because the author decided the other classes were implementation 
details and put them in the detail subdirectory.

In my own libraries I do not document anything in the detail subdirctory 
and I think that is the standard practice.