Fred wrote:
> code. You might want to look into it:
>
> http://www.zib.de/Visual/software/doc++/Introduction.html
doc++ is to the best of my knowledge not actively developed anymore.
I'd suggest to look into `doxygen', a tool derived from doc++. Start at
http://www.stack.nl/~dimitri/doxygen/index.html
There is not only a very active development and a growing user base.
The output generated by doxygen is imho better structured and easier
to read and navigate than what you get out of THtml.
Of course does doxygen generate hyperlinks for class names, and it
tries it's best to generate hyperlinks for method names too.
Doxygen uses a lexer and some heuristics to determine the scope of a
name. If it's unsure, it will not generate a hyperlink. In practice
this isn't a major issue though and by far outweighted by other
advantages like
* possibility to document inline functions
* possibility to put the documentation into .h, .c, or in both
* navigable class hierarchy diagram for each class
* availability of an alphabetic list of all (including inherited)
members for each class.
* supports links between different projects (via tagfiles)
* integration of examples and tutorials
We have used doxygen lately and are happy with it. As an example look at
http://www-kp3.gsi.de/www/dox/IDHbase/html/class_IDHrawStream.html
Regards, Walter
--
Walter F.J. Mueller Mail: W.F.J.Mueller@gsi.de
GSI, Abteilung KP3 Phone: +49-6159-71-2766
D-64291 Darmstadt FAX: +49-6159-71-2989
WWW: http://www-kp3.gsi.de/www/kp3/people/mueller.html
PGP: http://www-kp3.gsi.de/~mueller/pgp.shtml
This archive was generated by hypermail 2b29 : Tue Jan 04 2000 - 00:43:40 MET