Jump to content
  • Advertisement
Sign in to follow this  
Turold

Automatic HTML Documentation

This topic is 3631 days old which is more than the 365 day threshold we allow for new replies. Please post a new topic.

If you intended to correct an error in the post then please contact us.

Recommended Posts

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?

Share this post


Link to post
Share on other sites
Advertisement
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.

Share this post


Link to post
Share on other sites
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);
/// \endcode
int blahFunc(int a);

/*@}*/


Share this post


Link to post
Share on other sites
My code is C style C++ - more modules than classes. Doxygen examples look cool, exp. D-Bus. Thx! :)

Share this post


Link to post
Share on other sites
Sign in to follow this  

  • Advertisement
×

Important Information

By using GameDev.net, you agree to our community Guidelines, Terms of Use, and Privacy Policy.

Participate in the game development conversation and more when you create an account on GameDev.net!

Sign me up!