search

SimVascular / svFSIplus

svFSIplus is an open-source, parallel, finite element multi-physics solver.
https://simvascular.github.io/documentation/svfsi.html
Other
10 stars 26 forks source link

Add missing documentation? #109

Closed mrp089 closed 2 months ago

mrp089 commented 1 year ago

We currently get 1425 "not documented" warnings from Doxygen. It could be nice to get those to zero and check for the documentation in each pull request.

@ktbolt, @MatteoSalvador, do you think it's worth adding those comments? We could try to divide and conquer within the lab, depending on who works with what.

MatteoSalvador commented 1 year ago

@mrp089 I agree, we should follow a divide and conquer approach within the lab until we have at least a very minimal documentation for all the physics and solvers!

ktbolt commented 1 year ago

It would be good to add meaningful documentation, not just describe the input/output parameters. People could do this as they are adding functionality or bug fixes.

ktbolt commented 2 months ago

No activity, closing for now.