🔒 Locked

Automatic HTML Documentation

Started by Turold Jul 14, 2008 at 10:28 AM 2 replies 550+ views

Original Post

Jul 14, 2008 at 10:28 AM

I need a robust, free for commercial use tool, which will generate HTML documentation from source of my project. What are my choices? What is most popular?

_Sigma

118

_Sigma

Jul 14, 2008 at 10:40 AM

Quote:
generate HTML documentation from source

I assume you mean once you've added in comments!

I personally use Natural Docs. I think you can use it for w/e you want, however, I would double check that.

Doxygen is also popular from what I hear, however I have never personally used it.

//edit.
You don't mention what language...Java for example, has JavaDocs built in.

RobTheBloke

128

RobTheBloke

Jul 14, 2008 at 10:44 AM

I'm a doxygen fan myself....

/// \brief  a collection of functions relating to blah/// \defgroup BlahModule Blah Module/*@{*//// \brief  blah blah/// \param  a - stuff/// \return something/// \note /// example usage:/// \code///   int a = blahFunc(10);/// \endcodeint blahFunc(int a);/*@}*/

Turold

Author

Turold

Jul 14, 2008 at 12:54 PM

My code is C style C++ - more modules than classes. Doxygen examples look cool, exp. D-Bus. Thx! :)

Topic Locked

This topic has been locked by a moderator. New replies are not allowed.