KhronosGroup / KTX-Software

KTX (Khronos Texture) Library and Tools
Other
834 stars 222 forks source link

Fix issues newly flagged by Doxygen 1.11.0 #925

Closed MarkCallow closed 2 weeks ago

MarkCallow commented 2 weeks ago

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 https://github.com/doxygen/doxygen/issues/10957.