-
Notifications
You must be signed in to change notification settings - Fork 282
Introduce a doxygen-checking github action #5645
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
Introduce a doxygen-checking github action #5645
Conversation
This had been missed while we removed travis, but it's useful to check for problems with new documentation added.
3f4af70
to
7f071db
Compare
Codecov Report
@@ Coverage Diff @@
## develop #5645 +/- ##
========================================
Coverage 69.41% 69.41%
========================================
Files 1241 1241
Lines 100614 100614
========================================
Hits 69843 69843
Misses 30771 30771
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My apologies I thought I had fixed all of the doxygen issues in VSD.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me
/cbmc/src/goto-symex/symex_slice_class.h:25: warning: documented empty return type of symex_slicet::collect_open_variables | ||
/home/runner/work/cbmc/cbmc/src/solvers/smt2/smt2_conv.h:113: warning: documented empty return type of smt2_convt::convert_rounding_mode_FPA | ||
/home/runner/work/cbmc/cbmc/src/goto-symex/symex_slice_class.h:25: warning: documented empty return type of symex_slicet::collect_open_variables | ||
/home/runner/work/cbmc/cbmc/src/goto-instrument/cover_basic_blocks.h:122: warning: argument 'block.' of command @param is not found in the argument list of cover_basic_blockst::add_block_lines(cover_basic_blockst::block_infot &block, const goto_programt::instructiont &instruction) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This warning does not seem to appear in the old version. This isn't a problem in itself, but the commit is claiming its only changing path and line numbers.
|
||
# Check doxygen version | ||
EXPECTED_VERSION="1.8.16" | ||
EXPECTED_VERSION="1.8.17" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not a path or line number either.
Along with this, also add some warnings related to graph size produced by dot.
7f071db
to
522f51e
Compare
We used to have one in the Travis days, but somehow we lost
it when we removed the Travis configuration. This PR re-introduces it,
this time working on GitHub actions, along with updating the warnings
we are expecting.