Re: [boost] [test] Copy editing documentation

From: Nava Whiteford (nwhiteford_at_[hidden])
Date: 2007-03-09 07:11:03

> Date: Thu, 8 Mar 2007 15:15:26 -0500
> From: "Gennadiy Rozental" <gennadiy.rozental_at_[hidden]>
> Subject: Re: [boost] Copy editing documentation
> To: boost_at_[hidden]
> Message-ID: <espqtn$i0h$1_at_[hidden]>
>
> 
> "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.

I agree it makes a poor guide. However I think it is also useful to have a 
reference when writing a library. Something along the lines of 
http://www.sgi.com/tech/stl/Vector.html for example, I find invaluable.

--