|
|
Boost : |
From: Paul A Bristow (pbristow_at_[hidden])
Date: 2007-03-09 04:29:30
>-----Original Message-----
>From: boost-bounces_at_[hidden]
>[mailto:boost-bounces_at_[hidden]] On Behalf Of Gennadiy Rozental
>Sent: 08 March 2007 20:15
>To: boost_at_[hidden]
>Subject: Re: [boost] Copy editing documentation
>
>"Nava Whiteford" <nwhiteford_at_[hidden]> wrote in message
>news:Pine.LNX.4.44.0703081732010.24682-100000_at_vual.tchpc.tcd.ie...
>
>> I'd be interested in hearing your views. As an aside could the class
>> documentation not be generated directly from the source
> using something like Doxygen?
>
>I personally don't like docs produced using Doxygen (or
>similar). They still
>require considerable effort and in most cases look like
>reference rather
>than users guide/tutorial.
Strongly agree - OK for reference but using Doxygen usually deludes the programmer that he has done all he needs to - so there is no
"How to /How do I ..." content. Most people 'get it' much for quickly from examples - and only occasionally need reference info.
Paul
--- Paul A Bristow Prizet Farmhouse, Kendal, Cumbria UK LA8 8AB +44 1539561830 & SMS, Mobile +44 7714 330204 & SMS 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