Skip to content

Commit c8f92dc

Browse files
facontidavidefacontidavide
committed
improved doxygen
1 parent d198332 commit c8f92dc

File tree

6 files changed

+3289
-12
lines changed

6 files changed

+3289
-12
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,4 @@ TODO.md
3030
/docs/plans/*
3131
/coverage_report/*
3232
/coverage.info
33+
/doc/html/*

‎3rdparty/doxygen-awesome-css/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 - 2023 jothepro
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎3rdparty/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
// SPDX-License-Identifier: MIT
2+
/**
3+
4+
Doxygen Awesome
5+
https://github.com/jothepro/doxygen-awesome-css
6+
7+
Copyright (c) 2021 - 2025 jothepro
8+
9+
*/
10+
11+
class DoxygenAwesomeDarkModeToggle extends HTMLElement {
12+
// SVG icons from https://fonts.google.com/icons
13+
// Licensed under the Apache 2.0 license:
14+
// https://www.apache.org/licenses/LICENSE-2.0.html
15+
static lightModeIcon = `<svg xmlns="http://www.w3.org/2000/svg" enable-background="new 0 0 24 24" height="24px" viewBox="0 0 24 24" width="24px" fill="#FCBF00"><rect fill="none" height="24" width="24"/><circle cx="12" cy="12" opacity=".3" r="3"/><path d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"/></svg>`
16+
static darkModeIcon = `<svg xmlns="http://www.w3.org/2000/svg" enable-background="new 0 0 24 24" height="24px" viewBox="0 0 24 24" width="24px" fill="#FE9700"><rect fill="none" height="24" width="24"/><path d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27 C17.45,17.19,14.93,19,12,19c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z" opacity=".3"/><path d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"/></svg>`
17+
static title = "Toggle Light/Dark Mode"
18+
19+
static prefersLightModeInDarkModeKey = "prefers-light-mode-in-dark-mode"
20+
static prefersDarkModeInLightModeKey = "prefers-dark-mode-in-light-mode"
21+
22+
static _staticConstructor = function() {
23+
DoxygenAwesomeDarkModeToggle.enableDarkMode(DoxygenAwesomeDarkModeToggle.userPreference)
24+
// Update the color scheme when the browsers preference changes
25+
// without user interaction on the website.
26+
window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
27+
DoxygenAwesomeDarkModeToggle.onSystemPreferenceChanged()
28+
})
29+
// Update the color scheme when the tab is made visible again.
30+
// It is possible that the appearance was changed in another tab
31+
// while this tab was in the background.
32+
document.addEventListener("visibilitychange", visibilityState => {
33+
if (document.visibilityState === 'visible') {
34+
DoxygenAwesomeDarkModeToggle.onSystemPreferenceChanged()
35+
}
36+
});
37+
}()
38+
39+
static init() {
40+
$(function() {
41+
$(document).ready(function() {
42+
const toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
43+
toggleButton.title = DoxygenAwesomeDarkModeToggle.title
44+
toggleButton.updateIcon()
45+
46+
window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
47+
toggleButton.updateIcon()
48+
})
49+
document.addEventListener("visibilitychange", visibilityState => {
50+
if (document.visibilityState === 'visible') {
51+
toggleButton.updateIcon()
52+
}
53+
});
54+
55+
$(document).ready(function(){
56+
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
57+
})
58+
$(window).resize(function(){
59+
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
60+
})
61+
})
62+
})
63+
}
64+
65+
constructor() {
66+
super();
67+
this.onclick=this.toggleDarkMode
68+
}
69+
70+
/**
71+
* @returns `true` for dark-mode, `false` for light-mode system preference
72+
*/
73+
static get systemPreference() {
74+
return window.matchMedia('(prefers-color-scheme: dark)').matches
75+
}
76+
77+
/**
78+
* @returns `true` for dark-mode, `false` for light-mode user preference
79+
*/
80+
static get userPreference() {
81+
return (!DoxygenAwesomeDarkModeToggle.systemPreference && localStorage.getItem(DoxygenAwesomeDarkModeToggle.prefersDarkModeInLightModeKey)) ||
82+
(DoxygenAwesomeDarkModeToggle.systemPreference && !localStorage.getItem(DoxygenAwesomeDarkModeToggle.prefersLightModeInDarkModeKey))
83+
}
84+
85+
static set userPreference(userPreference) {
86+
DoxygenAwesomeDarkModeToggle.darkModeEnabled = userPreference
87+
if(!userPreference) {
88+
if(DoxygenAwesomeDarkModeToggle.systemPreference) {
89+
localStorage.setItem(DoxygenAwesomeDarkModeToggle.prefersLightModeInDarkModeKey, true)
90+
} else {
91+
localStorage.removeItem(DoxygenAwesomeDarkModeToggle.prefersDarkModeInLightModeKey)
92+
}
93+
} else {
94+
if(!DoxygenAwesomeDarkModeToggle.systemPreference) {
95+
localStorage.setItem(DoxygenAwesomeDarkModeToggle.prefersDarkModeInLightModeKey, true)
96+
} else {
97+
localStorage.removeItem(DoxygenAwesomeDarkModeToggle.prefersLightModeInDarkModeKey)
98+
}
99+
}
100+
DoxygenAwesomeDarkModeToggle.onUserPreferenceChanged()
101+
}
102+
103+
static enableDarkMode(enable) {
104+
if(enable) {
105+
DoxygenAwesomeDarkModeToggle.darkModeEnabled = true
106+
document.documentElement.classList.add("dark-mode")
107+
document.documentElement.classList.remove("light-mode")
108+
} else {
109+
DoxygenAwesomeDarkModeToggle.darkModeEnabled = false
110+
document.documentElement.classList.remove("dark-mode")
111+
document.documentElement.classList.add("light-mode")
112+
}
113+
}
114+
115+
static onSystemPreferenceChanged() {
116+
DoxygenAwesomeDarkModeToggle.darkModeEnabled = DoxygenAwesomeDarkModeToggle.userPreference
117+
DoxygenAwesomeDarkModeToggle.enableDarkMode(DoxygenAwesomeDarkModeToggle.darkModeEnabled)
118+
}
119+
120+
static onUserPreferenceChanged() {
121+
DoxygenAwesomeDarkModeToggle.enableDarkMode(DoxygenAwesomeDarkModeToggle.darkModeEnabled)
122+
}
123+
124+
toggleDarkMode() {
125+
DoxygenAwesomeDarkModeToggle.userPreference = !DoxygenAwesomeDarkModeToggle.userPreference
126+
this.updateIcon()
127+
}
128+
129+
updateIcon() {
130+
if(DoxygenAwesomeDarkModeToggle.darkModeEnabled) {
131+
this.innerHTML = DoxygenAwesomeDarkModeToggle.darkModeIcon
132+
} else {
133+
this.innerHTML = DoxygenAwesomeDarkModeToggle.lightModeIcon
134+
}
135+
}
136+
}
137+
138+
customElements.define("doxygen-awesome-dark-mode-toggle", DoxygenAwesomeDarkModeToggle);

‎3rdparty/doxygen-awesome-css/doxygen-awesome-sidebar-only.css‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
/* SPDX-License-Identifier: MIT */
2+
/**
3+
4+
Doxygen Awesome
5+
https://github.com/jothepro/doxygen-awesome-css
6+
7+
Copyright (c) 2021 - 2025 jothepro
8+
9+
*/
10+
11+
html {
12+
/* side nav width. MUST be = `TREEVIEW_WIDTH`.
13+
* Make sure it is wide enough to contain the page title (logo + title + version)
14+
*/
15+
--side-nav-fixed-width: 335px;
16+
--menu-display: none;
17+
18+
--top-height: 120px;
19+
--toc-sticky-top: -25px;
20+
--toc-max-height: calc(100vh - 2 * var(--spacing-medium) - 25px);
21+
}
22+
23+
#projectname {
24+
white-space: nowrap;
25+
}
26+
27+
28+
@media screen and (min-width: 768px) {
29+
html {
30+
--searchbar-background: var(--page-background-color);
31+
}
32+
33+
#side-nav {
34+
min-width: var(--side-nav-fixed-width);
35+
max-width: var(--side-nav-fixed-width);
36+
top: var(--top-height);
37+
overflow: visible;
38+
}
39+
40+
#nav-tree, #side-nav {
41+
height: calc(100vh - var(--top-height)) !important;
42+
}
43+
44+
#top {
45+
display: block;
46+
border-bottom: none;
47+
height: var(--top-height);
48+
margin-bottom: calc(0px - var(--top-height));
49+
max-width: var(--side-nav-fixed-width);
50+
overflow: hidden;
51+
background: var(--side-nav-background);
52+
}
53+
54+
#main-nav {
55+
float: left;
56+
padding-right: 0;
57+
}
58+
59+
.ui-resizable-handle {
60+
display: none;
61+
}
62+
63+
.ui-resizable-e {
64+
width: 0;
65+
}
66+
67+
#nav-path {
68+
position: fixed;
69+
right: 0;
70+
left: calc(var(--side-nav-fixed-width) + 1px);
71+
bottom: 0;
72+
width: auto;
73+
}
74+
75+
#doc-content {
76+
height: calc(100vh - 31px) !important;
77+
padding-bottom: calc(3 * var(--spacing-large));
78+
padding-top: calc(var(--top-height) - 80px);
79+
box-sizing: border-box;
80+
margin-left: var(--side-nav-fixed-width) !important;
81+
}
82+
83+
#MSearchBox {
84+
width: calc(var(--side-nav-fixed-width) - calc(2 * var(--spacing-medium)));
85+
}
86+
87+
#MSearchField {
88+
width: calc(var(--side-nav-fixed-width) - calc(2 * var(--spacing-medium)) - 65px);
89+
}
90+
91+
#MSearchResultsWindow {
92+
left: var(--spacing-medium) !important;
93+
right: auto;
94+
}
95+
96+
#nav-sync {
97+
bottom: 4px;
98+
right: auto;
99+
left: 300px;
100+
width: 35px;
101+
top: auto !important;
102+
user-select: none;
103+
position: fixed
104+
}
105+
}

0 commit comments

Comments
 (0)