Programming documentation

obr

Please can someone point me to any usefull software for creating programming documentation. Thanks obr

Serge Weinstock 2

Take a look at doxygen which is in my opinion a fantastic tool for documenting C++ sources. Serge :cool:

Thomas Freudenberg

I really recommend doxygen. Quote from its homepage:

Doxygen is a documentation system for C++, Java, IDL (Corba, Microsoft and KDE-DCOP flavors) and C. It can help you in three ways:

It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in ) from a set of documented source files. There is also support for generating output in RTF (MS-Word), Postscript, hyperlinked PDF, compressed HTML, and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.

Doxygen can be configured to extract the code structure from undocumented source files. This can be very useful to quickly find your way in large source distributions. The relations between the various elements are be visualized by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically.

You can even `abuse' doxygen for creating normal documentation (as I did for this manual).

Doxygen is developed under Linux, but is set-up to be highly portable. As a result, it runs on most other UNIX flavors as well. Furthermore, an executable for Windows 9x/NT is also available.

In conjunction with the MSDN Collection Integrator you can even add the generated CHM file into your MSDN and access your API documentation inside MsDev. Regards, Thomas

I am a signature virus! Help me spread and copy me to your sig!

Alvaro Mendez

I've used one called DocJet from Tall Tree, which is pretty nice. It integrates right into the DevStudio and can generate the documentation in HTML, HTMLHelp, WinHelp, and Word formats.