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

Upgrade to Doxygen 1.13.2 #1097

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Upgrade to Doxygen 1.13.2 #1097

wants to merge 5 commits into from

Conversation

azrogers
Copy link
Contributor

@azrogers azrogers commented Feb 4, 2025

Apparently, some point in the Doxygen releases from 1.12.0 to 1.13.2, our documentation build started breaking. I've filed a bug report for the main issue here - a bug in predefined macro expansion, doxygen/doxygen#11393 - but it turns out we can get away with just disabling EXPAND_ONLY_PREDEF, which means the issue doesn't appear. It seems whatever reason there was to turn this on in the first place is no longer present, as the documentation builds fine without it enabled.

Besides fixing the documentation build for 1.13.2 and updating the Doxygen version on CI, this PR also changes the way the EXAMPLE_PATH variable is set. Previously, we gave it the entire source tree as the example path, which led to every file in the directory (including build, node_modules, and any other cruft) being parsed before the documentation could be generated. Apparently, EXCLUDE_PATTERNS kicks in after this step in the process, so it had no effect. Instead, we glob every Cesium* folder and add each of those to the path to avoid any extra build files from slowing down our doc build.

@azrogers
Copy link
Contributor Author

azrogers commented Feb 5, 2025

Forgot to note that this closes #1086.

@azrogers
Copy link
Contributor Author

azrogers commented Feb 5, 2025

...and just realized I hadn't fixed Mermaid diagrams. Simple fix, the issue seems to be that ^^ was getting replaced with \ilinebr at a later stage than \ilinebr was getting replaced with \n. Replacing each ^^ with \ilinebr did the trick.

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