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

Support for Doxygen's WARN_AS_ERROR #19

Closed
saxbophone opened this issue May 6, 2021 · 1 comment
Closed

Support for Doxygen's WARN_AS_ERROR #19

saxbophone opened this issue May 6, 2021 · 1 comment

Comments

@saxbophone
Copy link

I use Doxyfile config including the following fragment to make Doxygen always fail if there are errors in my docs:

# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered.
# The default value is: NO.

WARN_AS_ERROR          = YES

On the command-line locally, this causes Doxygen to quit early, halting the doc generation process and returning non-success process exit code. I've previously used this technique for docs CI on Travis, but I noticed the docs generation failing doesn't fail the builds on Github Actions when using this action.

Is it feasible to add support for this workflow by exposing the doxygen command's exit code in the Github Action?

I know #7 is already open and is similar to this, but from what I have read on that other thread, what I'm asking about here seems to be something a bit different.

Thanks

@mattnotmitt
Copy link
Owner

mattnotmitt commented May 6, 2021

Just had a bit of a test with one of my repos, and after enabling WARN_AS_ERROR and removing a piece of documentation I was able to get it to fail. Doxygen is awfully strange with how it deals with warnings - could you check that what you're calling a "warning" isn't actually a printf statement with "warning" printed at the start of it?

EDIT: Oh wait, I think I see what you mean. Let me try adding some flags to the entrypoint script so it fails properly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants