Skip to content

Fix issues newly flagged by Doxygen 1.11.0 #925

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 7 commits into from
Jul 1, 2024
Merged

Conversation

MarkCallow
Copy link
Collaborator

@MarkCallow MarkCallow commented Jun 30, 2024

Some were genuine issues that surprisingly weren't flagged before:
astc_encode.cpp, ktx2check.c.

One is a change to an existing Doxygen issue that caused a
previously working reference to not be found: vkloader.c.

Includes these other documentation related changes:

  1. Change several ktxTexture references in ktxTexture2 to ktxTexture2 references.
  2. Update CI to install graphviz of which dot is part. With dot Doxygen provides nice include dependency, inverse include dependency, inheritance and other graphs.
  3. Make Doxygen skip the documentation for the ktxTexture macro as the existence of a same-named macro causes Doxygen to fail to make intra-class cross-references in the ktxTexture class.
  4. Fine tune the deprecation statements.
  5. Remove names from @file commands. These are unnecessary and error-prone. Three mismatches were spotted
    during this work.

IMPORTANT Documentation for releases must not be generated with Doxygen 1.11.0 as it has a bug that causes it to not add snippets to generated pages. See doxygen/doxygen#10957.

Some were genuine issues that surprisingly weren't flagged before:
astc_encode.cpp, ktx2check.c.

One is a change to an existing Doxygen issue that caused
previously working referencse to not be found: vkloader.c.

One is an improvement unrelated to 1.11: texture2.c.
Update CI to install graphviz, of which dot is part.
These are unnecessary and error-prone. Three mismatches were spotted
during this work.
@MarkCallow MarkCallow merged commit 19c2f75 into main Jul 1, 2024
@MarkCallow MarkCallow deleted the fix_doxy_1.11 branch July 1, 2024 08:18
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.

1 participant