search

hesim-dev / hesim

Health economic simulation modeling and decision analysis
https://hesim-dev.github.io/hesim/
62 stars 17 forks source link

Doxygen Specification #2

Closed jeff-m-sullivan closed 6 years ago

jeff-m-sullivan commented 6 years ago

This PR will add simple doxygen capability to the C++ portion of the hesim package. To generate the documentation, run 'doxygen Doxyfile' from the root of the checkout. There will then be a folder calls doxydoc, with subfolders dedicated to html and latex documentation.

I added sample documentation of a class, its members, and a non-specific main page. When possible, I used existing comments and transformed them into doxygen comments (i.e. changed '//' to '///').

codecov-io commented 6 years ago

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master       #2   +/-   ##
=======================================
  Coverage   89.46%   89.46%           
=======================================
  Files          28       28           
  Lines        2374     2374           
=======================================
  Hits         2124     2124           
  Misses        250      250
Impacted Files Coverage Δ
src/PartSurv.h 50% <ø> (ø) :arrow_up:

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 2b06abe...6da615a. Read the comment docs.