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.

Sign up for GitHub

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

Jump to bottom

CI Documentation warnings as Errors #128

Open
ptheywood opened this issue Nov 7, 2019 · 1 comment
Open

CI Documentation warnings as Errors #128

ptheywood opened this issue Nov 7, 2019 · 1 comment
Labels
CI Documentation

Comments

@ptheywood
Copy link
Member

To ensure this is fully documented, it might help to enforce documentation via CI.

Doxygen doesn't appear to support this natively, however with a little bit of bash magic it should be achieveable, i.e.

doxygen Doxyfile.docs 2>&1 | tee doxylog.log | grep ": warning: " | wc -l

will print the number of warnings output by doxygen.

We should achieve this by enabling CI checking in a draft pull request, and rebase periodicalyl to check on status.
@ptheywood
Copy link
Member Author

PR #546 is the beggingins of this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
CI Documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ptheywood