Add documentation - nenetto/CMakeTemplates GitHub Wiki

Let say that your executable or your library is already deployed. But you want to create a proper documentation for it. We will use Doxygen. You can find more information on the web and tutorials about how to comment properly using Doxygen standard guidelines.

The first thing you need to to is comment your code using this guidelines. After you do so, when configure your project on CMake, set the option {Your Project Name / Your Super Build Project Name}_BUILD_DOCUMENTATION to ON. [Configure & Generate] (https://github.com/nenetto/CMakeTemplates/wiki/Configure-and-Generate) and compile your code normally.

Your documentation will be found on your Build folder:

{Your Build Folder}\install\doc\*

If you are building a SuperBuild project, you will find a different folder for each subproject. To see your documentation, get into the folder of your project and open index.html.

Congrats, you got your source already documented! :+1: