Re: [boost] [Ann]: Dox - a C++ documentation tool

From: Narech Koumar (narechk_at_[hidden])
Date: 2005-06-19 03:17:30

Eric Goebelbecker wrote:
> The docs are up at http://www.ominor.net/boost/dox . 
> 
> I'm hoping to set up a method for automatically updating them in the
> next few weeks.

Hi Eric. Great job, thanks for your efforts! I have a few comments on 
the documentation so far.

1) The docs are very rough at the moment, in large part due to all the 
macros in boost code. An attempt to force macro expansion (in Doxygen's 
preprocessor) is worth a try since it may give a better and "more" 
correct view of the docs. Doxygen's parser can get confused by certain 
macro declarations.

2) There are some known defects in the Sunsys Dox, one of them is 
filename generation. Since the current batch of docs were produced on NT 
(file system non-casesensitive) the link to Namespaces->std is invalid: 
[summary]-std.html is overwrititten by [summary]-STD.html; there may be 
others.

3) Judging from the produced docs the boost code seems to be largely 
undocumented inline. A notable ecxeption is boost::program_options 
namespace.

4) Finally a warning to 56K users: broadband connection is recommended! 
Perhaps it can be arranged so that a downloadable version of .zip:ed 
docs if offered to those wishing to read offline.

Best regards,

- Narech Koumar