Skip to content

Align Doxygen versions used for website publishing and PR checks #7527

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

Merged
merged 4 commits into from
Feb 8, 2023

Conversation

thomasspriggs
Copy link
Contributor

@thomasspriggs thomasspriggs commented Feb 7, 2023

This PR aligns the Doxygen versions used for website publishing and PR checks.

  • Each commit message has a non-empty body, explaining why the change was made.
  • Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.
  • The feature or user visible behaviour I have added or modified has been documented in the User Guide in doc/cprover-manual/
  • Regression or unit tests are included, or existing tests cover the modified code (in this case I have detailed which ones those are in the commit message).
  • My commit message includes data points confirming performance improvements (if claimed).
  • My PR is restricted to a single feature or bugfix.
  • White-space or formatting changes outside the feature-related changed lines are in commits of their own.

The publish job uses `ubuntu-latest` which is currently Ubuntu 22.04.
Switching to specifying 22.04 allows us to manage the point as which the
versions are updated.

Updating the version of Ubuntu used for the doxygen-check job from
Ubuntu 20.04 to 22.04 matches the check job against the publishing job.
The changes to the doxyfile are exactly those carried out by running
`doxygen -u` to update it only.

Doxygen warnings added to warnings file will be fixed in subsequent
commits, in this PR.
`a4wide` is not longer available and `a4` is what doxygen would
otherwise default to.
The `<!--` `-->` hack to continue a reference overmultiple lines no
longer works in Doxygen 1.9.1. This commit avoids the need for a hack by
fitting the reference on a single line. The class name `ai_baset` can be
safely ommitted from the reference, because this block of doxygen is
already assoicated with the `ai_baset` class.
@codecov
Copy link

codecov bot commented Feb 7, 2023

Codecov Report

Base: 78.49% // Head: 78.49% // No change to project coverage 👍

Coverage data is based on head (646101f) compared to base (28d235e).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #7527   +/-   ##
========================================
  Coverage    78.49%   78.49%           
========================================
  Files         1663     1663           
  Lines       191330   191330           
========================================
  Hits        150176   150176           
  Misses       41154    41154           
Impacted Files Coverage Δ
src/analyses/ai.h 64.28% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@thomasspriggs thomasspriggs merged commit b5bf362 into diffblue:develop Feb 8, 2023
@thomasspriggs thomasspriggs deleted the tas/doxygen_versions branch February 8, 2023 11:13
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

Successfully merging this pull request may close these issues.

4 participants