Jump to content
  • Advertisement
Sign in to follow this  
PureW

Anything similar to Javadoc in C++?

This topic is 4251 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've been using C++ in my spare time, but never did any larger projects. But now I have this idea on a project that potentially could evolve into something large. But I'd need very detailed documentation, and since I recently began with java at the university I thought of the javadoc program which is fantastic. Now to the question, is there a similar program but for c++ that converts special comments into a detailed documentation of your code?

Share this post


Link to post
Share on other sites
Advertisement
My vote goes for Doxygen. VS2005 has an XML-based tool as well, but I'm not nearly as happy with it, since it tends to be painfully verbose (esp. compared to Doxygen).

Share this post


Link to post
Share on other sites
You're probably looking for Doxygen.

I'd like to point out that "very detailed documentation" is a lot more than a set of glorified code comments though. [smile]

Share this post


Link to post
Share on other sites
what sucks about those documentation tools mentioned here is the visual format. There are big words here, small words there, colored blocks up and down the page, thin horizontal rules, fat horizontal rules, hyper links that link to an anchor on the same page, and worst of all is the description of a class's internals is packed into one page. It is inconvenient for me to have to scroll through a huge page to find what I'm looking for, especially if the page is clamored with unnecessary visual details. Documentation with these kinds of user interfaces is very puzzling.

DoxyS is the tool for the job.

On the other hand, you're looking for something similar to Javadoc.
Since DoxyS does not suck, it is prrroobably not what you're looking for. lol

Share this post


Link to post
Share on other sites
Guest Anonymous Poster
Quote:
Original post by badbrain
what sucks about those documentation tools mentioned here is the visual format. There are big words here, small words there, colored blocks up and down the page, thin horizontal rules, fat horizontal rules, hyper links that link to an anchor on the same page, and worst of all is the description of a class's internals is packed into one page. It is inconvenient for me to have to scroll through a huge page to find what I'm looking for, especially if the page is clamored with unnecessary visual details. Documentation with these kinds of user interfaces is very puzzling.


I agree, most of the DoxyGen output may look like a real mess, likewise for the DoxyGen source code itself, however for quite some time now DoxyGen supports not only HTML and LaTex (PDF) as output formats, but also XML-that way, you can simply use the generated XML in order to transform it to arbitrary output formats, i.e. using XSL stylesheets.

Share this post


Link to post
Share on other sites
Quote:
Original post by evolutional
I prefer NaturalDocs


I second that, mainly because the documentation style is natural enough that the comments work quite well as readable comments too. (Almost no formatting.)
The output also looks quite good, which is also a plus for me.

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.

We are the game development community.

Whether you are an indie, hobbyist, AAA developer, or just trying to learn, GameDev.net is the place for you to learn, share, and connect with the games industry. Learn more About Us or sign up!

Sign me up!