Visual studio c++ documentation generator [closed]

Answer 1

If you are using Visual Studio 2015 then there is a Doxygen generator written for the Macro explorer extension which uses JavaScript for it's macro language.

Project is on github here: https://github.com/cppocl/visual_studio_macros

Answer 2

If you don't mind, some hand written documentation, then sphinx is the perfect tool.

http://www.sphinx-doc.org/en/stable/

and here is example:

http://ceres-solver.org/

sphinx-build -b singlehtml doc/ build/

Answer 3

One way to generate documentation is - you guessed it - javadoc. You simply have to comment the same way you usually do, and javadoc does a good job of converting them to HTML/LaTeX style.

Of course, that's not the only solution. I'll leave room for others.

Answer 4

You could use the XML-Documentation format, supported by VS2010, too. http://msdn.microsoft.com/en-us/library/ms177226%28VS.80%29.aspx

After commenting your code, you can use Sandcastle to create a MSDN-like documentation: http://sandcastle.codeplex.com/. (Here is a GUI representation for Sandcastle, which is a lot easier to use: https://github.com/EWSoftware/SHFB)

I use AtomineerUtils to create the XML-Documentation headers automatically. This tool will help you a lot. You can have free base version here: http://www.atomineerutils.com/products.php

Answer 5

You can have a look at Doxygen.

Answer 6

Also, take a look at CppTripleSlash - xml doc comments for c++. It is a free Visual Studio 2015, 2013, 2012, 2010 extension.