TheLartians / ModernCppStarter

🚀 Kick-start your C++! A template for modern C++ projects using CMake, CI, code coverage, clang-format, reproducible dependency management and much more.
https://thelartians.github.io/ModernCppStarter
The Unlicense
4.45k stars 388 forks source link

Doxygen support #43

Closed TheLartians closed 4 years ago

TheLartians commented 4 years ago

This PR will add automatic documentation targets using doxygen.

Current usage

cmake -Hdocumentation -Bbuild/doc
cmake --build build/doc --target GenerateDocs
# view the docs (on Mac)
open build/doc/doxygen/html/index.html

Questions

TODO

closes #40

codecov[bot] commented 4 years ago

Codecov Report

Merging #43 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master       #43   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           12        12           
=========================================
  Hits            12        12           
Impacted Files Coverage Δ
include/greeter.h 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 9ede321...c44ee93. Read the comment docs.

TheLartians commented 4 years ago

With some questions still unanswered, this is probably a good starting point for documentations and the template can be updated as more best practices become apparent.