Javadoc-like documentation for C ++

Question

Are there similar documentation generation systems like Javadoc for C ++? Javadoc produces a good result; It would be great if you could use something similar in other languages.

Answer 1

There are several tools that work like JavaDoc for C ++. The most popular tool is probably doxygen . It can handle JavaDoc-like comments, as well as several languages ​​(e.g. C ++, C, Java, Objective-C, Python, PHP, C #). It has pretty good support for customizing the style of HTML output using CSS (see List of users for sample documentation).

When choosing a documentation system it is necessary to solve two important problems:

• Document the entities that interest you. Do you want to document the system in accordance with the code structure or in accordance with some other units of the module?
• Receive output in the format you want. This is preferable when the documentation matches your overall design style.

Our experience with doxygen is that it is fairly easy to configure and use, and the result is fairly easy to configure. Unfortunately, doxygen is not ideal, so in some cases it is necessary to bypass quirks or errors when the doxygen parser fails. Be sure to carefully study all the documentation you created.

Answer 2

You cannot use javadoc on purpose, but there are several tools that do what you want. Most people tend to use Doxygen. Here are some links for Doxygen and DoC ++:

Doxygen
DoC ++

Answer 3

There doxygen

Answer 4

There is also qdoc for QT based C ++ projects. http://doc-snapshot.qt-project.org/qdoc

Answer 5

I am just starting to use Sphinx for my Python projects. On his homepage it says that "C / C ++ is already supported."

It uses lightweight markup called " reStructuredText ".

I just started using it for my Python projects, and I really liked its look.