SimVascular / SimVascular/svZeroDSolver
Require all source code files to be included in Doxygen documentation
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 22
- Forks
- 44
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Doxygen GitHub Actions configuration and reviewing how undocumented code currently causes the action to fail. Determine how source files without a @file tag are excluded, then verify the workflow also detects those files. Done means every source code file is included in the Doxygen build and undocumented code remains blocked from merging.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, github-actions
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100