The open source OpenXR runtime

doc: Add mermaid diagram support to Doxygen config

Part-of: <https://gitlab.freedesktop.org/monado/monado/-/merge_requests/2300>

Changed files
+45 -3
doc
+5 -1
doc/Doxyfile.in
··· 10 11 12 IMAGE_PATH = @SRCDIR@/doc 13 14 USE_MDFILE_AS_MAINPAGE = @SRCDIR@/doc/mainpage.md 15 ··· 54 ALIASES += TODO=todo 55 ALIASES += ep{1}="<b>\1</b>. \xrefitem entrypoints \"OpenXR Entry Point\" \"OpenXR Entry Points\" \1" 56 ALIASES += obj{1}="\xrefitem objects \"OpenXR Object\" \"OpenXR Objects\" \1" 57 58 SHOW_GROUPED_MEMB_INC = YES 59 STRIP_CODE_COMMENTS = NO ··· 102 FULL_SIDEBAR = NO 103 HTML_COLORSTYLE = LIGHT # required with Doxygen >= 1.9.5 104 HTML_HEADER = @SRCDIR@/doc/header.html 105 HTML_EXTRA_STYLESHEET = @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome.css 106 HTML_EXTRA_FILES = @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \ 107 @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \ 108 @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome-paragraph-link.js \ 109 @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome-interactive-toc.js \ 110 - @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome-tabs.js
··· 10 11 12 IMAGE_PATH = @SRCDIR@/doc 13 + EXAMPLE_PATH = @SRCDIR@/doc/mermaid 14 15 USE_MDFILE_AS_MAINPAGE = @SRCDIR@/doc/mainpage.md 16 ··· 55 ALIASES += TODO=todo 56 ALIASES += ep{1}="<b>\1</b>. \xrefitem entrypoints \"OpenXR Entry Point\" \"OpenXR Entry Points\" \1" 57 ALIASES += obj{1}="\xrefitem objects \"OpenXR Object\" \"OpenXR Objects\" \1" 58 + ALIASES += mermaid{1}="@htmlonly <div class=\"mermaid\"> ^^ @endhtmlonly @htmlinclude \"\1.mmd\" @htmlonly ^^ </div> @endhtmlonly" 59 60 SHOW_GROUPED_MEMB_INC = YES 61 STRIP_CODE_COMMENTS = NO ··· 104 FULL_SIDEBAR = NO 105 HTML_COLORSTYLE = LIGHT # required with Doxygen >= 1.9.5 106 HTML_HEADER = @SRCDIR@/doc/header.html 107 + HTML_FOOTER = @SRCDIR@/doc/footer.html 108 HTML_EXTRA_STYLESHEET = @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome.css 109 HTML_EXTRA_FILES = @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \ 110 @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \ 111 @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome-paragraph-link.js \ 112 @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome-interactive-toc.js \ 113 + @SRCDIR@/doc/doxygen-awesome-css/doxygen-awesome-tabs.js \ 114 + @SRCDIR@/src/external/mermaid/mermaid.min.js
+36
doc/footer.html
···
··· 1 + <!-- 2 + Copyright 2024, Collabora, Ltd. 3 + SPDX-License-Identifier: BSL-1.0 4 + --> 5 + <!-- 6 + Generated by `doxygen -w header.html footer.html ignored.css` command and 7 + then modified based on https://github.com/tttapa/doxygen-mermaid 8 + --> 9 + <!-- HTML footer for doxygen 1.9.4--> 10 + <!-- start footer part --> 11 + <script> 12 + mermaid.initialize({ 13 + startOnLoad: true, 14 + theme: 'dark', 15 + /* themeVariables: { 16 + primaryColor: '#f4f4ff', 17 + secondaryColor: 'rgba(244,244,255,0.9)', 18 + tertiaryColor: '#F9FAFC', 19 + },*/ 20 + }); 21 + </script> 22 + <!--BEGIN GENERATE_TREEVIEW--> 23 + <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> 24 + <ul> 25 + $navpath 26 + <li class="footer">$generatedby <a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion </li> 27 + </ul> 28 + </div> 29 + <!--END GENERATE_TREEVIEW--> 30 + <!--BEGIN !GENERATE_TREEVIEW--> 31 + <hr class="footer"/><address class="footer"><small> 32 + $generatedby&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion 33 + </small></address> 34 + <!--END !GENERATE_TREEVIEW--> 35 + </body> 36 + </html>
+4 -2
doc/header.html
··· 4 --> 5 6 <!-- 7 - Generated by `doxygen -w header.html ignored.html ignored.css`command and 8 - then modified based on doxygen-awesome header.html file 9 --> 10 11 <!-- HTML header for doxygen 1.9.4--> ··· 42 <script type="text/javascript" src="$relpath^doxygen-awesome-interactive-toc.js"></script> 43 <script type="text/javascript" src="$relpath^doxygen-awesome-tabs.js"></script> 44 <script type="text/javascript" src="$relpath^toggle-alternative-theme.js"></script> 45 <script type="text/javascript"> 46 DoxygenAwesomeFragmentCopyButton.init() 47 DoxygenAwesomeDarkModeToggle.init()
··· 4 --> 5 6 <!-- 7 + Generated by `doxygen -w header.html ignored.html ignored.css` command and 8 + then modified based on doxygen-awesome header.html file as well as 9 + https://github.com/tttapa/doxygen-mermaid 10 --> 11 12 <!-- HTML header for doxygen 1.9.4--> ··· 43 <script type="text/javascript" src="$relpath^doxygen-awesome-interactive-toc.js"></script> 44 <script type="text/javascript" src="$relpath^doxygen-awesome-tabs.js"></script> 45 <script type="text/javascript" src="$relpath^toggle-alternative-theme.js"></script> 46 + <script type="text/javascript" src="$relpath^mermaid.min.js"></script> 47 <script type="text/javascript"> 48 DoxygenAwesomeFragmentCopyButton.init() 49 DoxygenAwesomeDarkModeToggle.init()