Date: Thu, 8 Mar 2007 15:15:26 -0500 From: "Gennadiy Rozental" <gennadiy.rozental@thomson.com> Subject: Re: [boost] Copy editing documentation To: boost@lists.boost.org Message-ID: <espqtn$i0h$1@sea.gmane.org>
"Nava Whiteford" <nwhiteford@tchpc.tcd.ie> wrote in message news:Pine.LNX.4.44.0703081732010.24682-100000@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. --