Subject: Re: [boost] [convert] incomplete reference documentation
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2011-04-06 04:26:15
> -----Original Message-----
> From: boost-bounces_at_[hidden] [mailto:boost-bounces_at_[hidden]]
> On Behalf Of Vicente BOTET
> Sent: Wednesday, April 06, 2011 8:09 AM
> To: boost_at_[hidden]
> Subject: Re: [boost] [convert] incomplete reference documentation
> > 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've ticked the DoxyWizard WARN_IF_UNDOCUMENTED, WARN_IF_DOC_ERROR AND WARN_NO_PARAMDOC options
and sent the warning to a WARN_LOGFILE.
(And similarly in the jamfile)
If you see that the file is not empty, you know there is more to do :-(
And it lists the TODOs.
But it does get very tedious if you come along to do it afterwards:-((
So I've written "note to self" to do Doxygen comments when writing the code in the first place (but that is distracting).
No such thing as a free lunch!
--- Paul A. Bristow, Prizet Farmhouse, Kendal LA8 8AB UK +44 1539 561830 07714330204 pbristow_at_[hidden]
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk