good c++ documentation design example?

Question

Hello.

I'm tuning documentation generator for internal purpose that generates HTML documentation for C++ classes and methods. Is it any example available of good HTML documentation design? MSDN ( like this ) looks kinda outdated, same is doxygen / javadoc / sphinx results. Anyone ever see an documentation that looks REALLY good?

Answer 1

I think that "good HTML documentation design" is a very subjective topic. I find doxygen generated docs very useful and clean. And that is the feature I value the most when it comes to documentation.

However I find docs for Android (see reference doc or dev guide) both useful and nicely looking (even though it is for java).

Another nicely looking docs I use are: Qt docs - c++ and Dojo - js.

Answer 2

Have a look at the documentation of Boost libraries, for example the documentation of the Math library. I don't know how it is generated, but I won't be surprised if it is doxygen. Doxygen is actually the standard for C++ documentation. It is very flexible and you can easily use CSS to customize the appearance.

Answer 3

I think Doxygen is probably the standard for C++ documentation. The multiple output formats (HTML, Latex, PDF etc) are a great feature too.

The GTKmm documentation is a great example of what is possible with Doxygen. I think they only use the inheritance diagrams, but you can also generate collaboration diagrams and file usage diagrams (file1.h includes file2.h etc).

Answer 4

I really like the allegro.cc documentation for the Allegro game programming library.

Here's a good example page that shows some of the special features:

• "Related Discussions" integrates with www.allegro.cc's forums (automatically grabs relevant search results)
• "Related Projects" integrates with www.allegro.cc's project listings (projects that use this keyword)
• From an aesthetic view, the design is very clean and simple.