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

Updates related to doxygen version change #5220

Merged

Conversation

dzenanz
Copy link
Member

@dzenanz dzenanz commented Feb 6, 2025

Addresses multiple recently introduced changes. Closes #5219. Closes #5218. Closes #5180.

PR Checklist

  • No API changes were made (or the changes have been approved)
  • No major design changes were made (or the changes have been approved)
  • Updated API documentation (or API not changed)

@github-actions github-actions bot added type:Documentation Documentation improvement or change area:Segmentation Issues affecting the Segmentation module labels Feb 6, 2025
@jhlegarreta
Copy link
Member

The commit message title and body are tagging a GitHub user: maybe enclosing {at}cite in backticks or quotes prevents this.

@dzenanz dzenanz changed the title DOC: Fix warning about command @cite found as part of a title section Updates related to doxygen version change Feb 6, 2025
@github-actions github-actions bot added type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots area:Numerics Issues affecting the Numerics module area:Documentation Issues affecting the Documentation module labels Feb 6, 2025
albert-github and others added 3 commits February 6, 2025 10:52
Addresses warning about incorrect usage of the `@cite` command like:

`Modules/Segmentation/LevelSets/include/itkCurvesLevelSetFunction.h:49: warning: Illegal command '@cite' found as part of a title section`
The warning addressed:

Modules/Numerics/Optimizersv4/include/itkLBFGS2Optimizerv4.h:139: warning: Found unknown command '\dennis1983'
By upgrading doxygen version from 1.9.6 to 1.13.2, the defaults for these settings changed from:

GENERATE_TREEVIEW = NO
DISABLE_INDEX = NO

to

GENERATE_TREEVIEW = YES
DISABLE_INDEX = YES

Co-authored-by: Albert GitHub <albert.tests@gmail.com>
@github-actions github-actions bot removed the type:Documentation Documentation improvement or change label Feb 6, 2025
@hjmjohnson hjmjohnson merged commit 52f213e into InsightSoftwareConsortium:master Feb 7, 2025
15 checks passed
@dzenanz dzenanz deleted the citeTitleWarning branch February 7, 2025 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:Documentation Issues affecting the Documentation module area:Numerics Issues affecting the Numerics module area:Segmentation Issues affecting the Segmentation module type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots
Projects
None yet
4 participants