search

epfl-ecps / channelflow

Channelflow is a software system for numerical analysis of the incompressible fluid flow in channel geometries, written in C++ and MPI-parallelized.
GNU General Public License v2.0
65 stars 29 forks source link

add Doxygen #11

Closed mirkofarano closed 5 years ago

mirkofarano commented 5 years ago

In this PR a command line for generating Doxygen documentation has been added (make doc). A short description has been added to the INSTALL.md file.

codecov-io commented 5 years ago

Codecov Report

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

Impacted file tree graph

@@          Coverage Diff           @@
##           master     #11   +/-   ##
======================================
  Coverage    27.2%   27.2%           
======================================
  Files          63      63           
  Lines       15328   15328           
  Branches     7253    7253           
======================================
  Hits         4170    4170           
  Misses      11158   11158

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 a6c6594...e395a54. Read the comment docs.

mirkofarano commented 5 years ago

Food for thought: Can the documentation be autogenerated by the CI in an online, public place?

I guess so, but I'll need to check when I have more time.