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.

Sign up for GitHub

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

Various improvements for Doxygen #1582

Merged
merged 3 commits into from
Jan 17, 2025
Merged

Various improvements for Doxygen #1582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d177f26
Fix markdown problems
azrogers Jan 9, 2025
e82bd8e
Bring over Mermaid support from Cesium Native
azrogers Jan 9, 2025
36b1b93
Merge branch 'main' of github.com:CesiumGS/cesium-unreal into doxygen…
azrogers Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2,314 changes: 2,314 additions & 0 deletions Documentation/Assets/mermaid.min.js
View file
Open in desktop

Large diffs are not rendered by default.

12,323 changes: 12,323 additions & 0 deletions Documentation/Assets/mingcute.json.js
View file
Open in desktop

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions Documentation/Assets/panzoom.js
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 8 additions & 4 deletions Documentation/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,9 @@ TAB_SIZE = 4
# with the commands \{ and \} for these it is advised to use the version @{ and
# @} or use a double escape (\\{ and \\})

ALIASES =
ALIASES = mermaid{1}="\htmlonly <div class=\"mermaid\"> \endhtmlonly \htmlinclude \"\1.mmd\" \htmlonly </div> \endhtmlonly" \
mermaid-interactive{1}="\htmlonly <div class=\"mermaid interactive\"> \endhtmlonly \htmlinclude \"\1.mmd\" \htmlonly </div> \endhtmlonly" \
svg-interactive{2}="\htmlonly <div class=\"svg interactive\" style=\"min-height: \2\"> \endhtmlonly \image html \"\1.svg\" \htmlonly </div> \endhtmlonly"

# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
Expand Down Expand Up @@ -1077,7 +1079,7 @@ EXCLUDE_SYMBOLS = CesiumMetadataConversions<*
# that contain example code fragments that are included (see the \include
# command).

EXAMPLE_PATH =
EXAMPLE_PATH = ./Documentation/Diagrams

# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
Expand Down Expand Up @@ -1367,7 +1369,7 @@ HTML_HEADER =
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_FOOTER =
HTML_FOOTER = ./Documentation/footer.html

# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
Expand Down Expand Up @@ -1407,7 +1409,9 @@ HTML_EXTRA_STYLESHEET = ./node_modules/doxygen-awesome-css/doxygen-awesome.css
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_FILES =
HTML_EXTRA_FILES = ./Documentation/Assets/mermaid.min.js \
./Documentation/Assets/mingcute.json.js \
./Documentation/Assets/panzoom.js

# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
# should be rendered with a dark or light theme.
Expand Down
Loading
Loading