SimVascular / svZeroDSolver

A C++ lumped-parameter solver for blood flow and pressure in hemodynamic networks
Other
6 stars 18 forks source link

Require all source code files to be included in Doxygen documentation #80

Open menon-karthik opened 9 months ago

menon-karthik commented 9 months ago

We currently have the Doxygen Github actions set up so that undocumented code makes the action fail and is automatically blocked from being merged. However, we recently discovered that undocumented code can sneak in if it is in a source file which does not have a @file tag at the top and Doxygen doesn't see it as a result. It would be great to block this loop-hole and automatically enforce that every source file is included in the Doxygen build.