Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
menon-karthik opened this issue Dec 2, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@menon-karthik
Copy link
Member

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.

@menon-karthik menon-karthik added enhancement New feature or request documentation Improvements or additions to documentation labels Dec 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant