[boost] Re: Re: Reference documentation

From: Patrik Ellren (patrik.ellren_at_[hidden])
Date: 2002-10-31 02:32:08

"David Bergman" <davidb_at_[hidden]> wrote in message
news:000c01c28066$264d12c0$c901a8c0_at_ALBINONI...
> (forgive me for speaking with a Java tongue here)
>
> Does anyone know if there is a "javadoc" for C++ ("cplusdoc")? If not, I
> can investigate
> the matter.
>

I think it is surprising that no one has mentioned Doxygen yet, or have I
missed something?
It runs on several platforms and can generate XML, HTML, Latex, RTF,
Postscript, PDF,
man pages etc. I have used it on Windows to generate documentation for some
of the projects
I've been involved in and it seems to work fine (although I've mostly used
the HTML output).

It works like Javadoc but it has more features, you can for example name
sections and only
generate output from the ones you are interested in (so you could strip out
things when
generating a reference manual).

I think it is possible to keep the Doxygen comments separate from the source
files at the price
of some more typing.

Might be worth a look, more information at:
http://www.stack.nl/~dimitri/doxygen/

/Patrik Ellrén