CXX-3085 Upgrade to Doxygen 1.12.0 #1188
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kevinAlbs
approved these changes
Aug 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Followup to #1185:
The Doxygen changelog was updated with 1.12.0 release notes. I believe the upgrade to be worth implementing now. This PR also demonstrates the relatively few changes required for a less-significant Doxygen version upgrade compared to all the additional diffs to config and layout files in #1185.
Comparisons
The most notable change is the omission of classes in the Namespaces List page.
With 1.11.0:
With 1.12.0:
imo this is a very worthwhile improvement which makes the Namespaces List much easier to navigate. This also lessens the importance of CXX-3086 (although I would still like for it to be implemented if able).
The simpler Namespaces Page also made more apparent stray
@namespacedocs of nonexistentbsoncxx::v_noabi::exceptionandbsoncxx::exceptionnamespaces (which was confused with the class), introduced in #1173. This PR removes these stray docs accordingly.Although we do not yet heavily use Markdown syntax yet in Doxygen docs, 1.12.0 fixes several parsing and rendering issues for Markdown syntax. Addressing this issue now will help with writing more comprehensive examples in CXX-3082, which is expected to heavily rely on Markdown syntax for topic page layout and formatting.
The PR also includes a drive-by fix of an incorrect return type and parameter name used for the new
concatenateoverloads for arrays added in #1185.