-----Original Message----- From: boost-bounces@lists.boost.org [mailto:boost-bounces@lists.boost.org] On Behalf Of Andrey Semashev Sent: Sunday, March 21, 2010 11:21 AM To: boost@lists.boost.org Subject: Re: [boost] [Boost.Locale] More updates
I didn't evaluate the library closely, but I'm pretty sure that people will want to see Doxygen reference integrated into the Quickbook documentation, not vise-versa. Also, if the library has a compiled part, a section that describes configuration and building process would be most welcome.
They might *also* want to see the 'normal' Doxygen display because it is more compact and easier to read. I find that this especially for 'big' complicated libraries which are well Doxygen commented like Units, SVG Plot (as opposed to others like Math which have no Doxygen comments - yet - and just use Doxygen as a way or avoiding copying the class descriptors etc, a immensely tedious and error prone process). I have found it useful to have the Doxygen display in one window and the html or pdf docs in another window. (I have also found it very convenient to use the Doxywizard to build the Doxygen version - very quickly, and make sure that there are no mistakes in the doxygen comments (by checking the log file is empty) as it is *much* more difficult to trace these once incorporated into the final html or pdf build. Since you have to set up a doxyfile for this anyway, it would be little trouble to provide this small file as part of the release (perhaps at libs/mylib/docs/doxygen/doxyfile) so that users can create the Doxygen docs if they wish). Paul --- Paul A. Bristow Prizet Farmhouse Kendal, UK LA8 8AB +44 1539 561830, mobile +44 7714330204 pbristow@hetp.u-net.com