Skip to content

Commit cee11a3

Browse files
author
MFC Action
committed
Docs @ 202033e
1 parent e0e3c3b commit cee11a3

File tree

3,887 files changed

+274015
-14510
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

3,887 files changed

+274015
-14510
lines changed

‎api/clipboard.js‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
/**
2+
3+
The code below is based on the Doxygen Awesome project, see
4+
https://github.com/jothepro/doxygen-awesome-css
5+
6+
MIT License
7+
8+
Copyright (c) 2021 - 2022 jothepro
9+
10+
Permission is hereby granted, free of charge, to any person obtaining a copy
11+
of this software and associated documentation files (the "Software"), to deal
12+
in the Software without restriction, including without limitation the rights
13+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14+
copies of the Software, and to permit persons to whom the Software is
15+
furnished to do so, subject to the following conditions:
16+
17+
The above copyright notice and this permission notice shall be included in all
18+
copies or substantial portions of the Software.
19+
20+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26+
SOFTWARE.
27+
28+
*/
29+
30+
let clipboard_title = "Copy to clipboard"
31+
let clipboard_icon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path fill="#888" d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z"/></svg>`
32+
let clipboard_successIcon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41L9 16.17z"/></svg>`
33+
let clipboard_successDuration = 1000
34+
35+
$(function() {
36+
if(navigator.clipboard) {
37+
const fragments = document.getElementsByClassName("fragment")
38+
for(const fragment of fragments) {
39+
const clipboard_div = document.createElement("div")
40+
clipboard_div.classList.add("clipboard")
41+
clipboard_div.innerHTML = clipboard_icon
42+
clipboard_div.title = clipboard_title
43+
$(clipboard_div).click(function() {
44+
const content = this.parentNode.cloneNode(true)
45+
// filter out line number and folded fragments from file listings
46+
content.querySelectorAll(".lineno, .ttc, .foldclosed").forEach((node) => { node.remove() })
47+
let text = content.textContent
48+
// remove trailing newlines and trailing spaces from empty lines
49+
text = text.replace(/^\s*\n/gm,'\n').replace(/\n*$/,'')
50+
navigator.clipboard.writeText(text);
51+
this.classList.add("success")
52+
this.innerHTML = clipboard_successIcon
53+
window.setTimeout(() => { // switch back to normal icon after timeout
54+
this.classList.remove("success")
55+
this.innerHTML = clipboard_icon
56+
}, clipboard_successDuration);
57+
})
58+
fragment.insertBefore(clipboard_div, fragment.firstChild)
59+
}
60+
}
61+
})

‎api/cookie.js‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
/*!
2+
Cookie helper functions
3+
Copyright (c) 2023 Dimitri van Heesch
4+
Released under MIT license.
5+
*/
6+
let Cookie = {
7+
cookie_namespace: 'doxygen_',
8+
9+
readSetting(cookie,defVal) {
10+
if (window.chrome) {
11+
const val = localStorage.getItem(this.cookie_namespace+cookie) ||
12+
sessionStorage.getItem(this.cookie_namespace+cookie);
13+
if (val) return val;
14+
} else {
15+
let myCookie = this.cookie_namespace+cookie+"=";
16+
if (document.cookie) {
17+
const index = document.cookie.indexOf(myCookie);
18+
if (index != -1) {
19+
const valStart = index + myCookie.length;
20+
let valEnd = document.cookie.indexOf(";", valStart);
21+
if (valEnd == -1) {
22+
valEnd = document.cookie.length;
23+
}
24+
return document.cookie.substring(valStart, valEnd);
25+
}
26+
}
27+
}
28+
return defVal;
29+
},
30+
31+
writeSetting(cookie,val,days=10*365) { // default days='forever', 0=session cookie, -1=delete
32+
if (window.chrome) {
33+
if (days==0) {
34+
sessionStorage.setItem(this.cookie_namespace+cookie,val);
35+
} else {
36+
localStorage.setItem(this.cookie_namespace+cookie,val);
37+
}
38+
} else {
39+
let date = new Date();
40+
date.setTime(date.getTime()+(days*24*60*60*1000));
41+
const expiration = days!=0 ? "expires="+date.toGMTString()+";" : "";
42+
document.cookie = this.cookie_namespace + cookie + "=" +
43+
val + "; SameSite=Lax;" + expiration + "path=/";
44+
}
45+
},
46+
47+
eraseSetting(cookie) {
48+
if (window.chrome) {
49+
if (localStorage.getItem(this.cookie_namespace+cookie)) {
50+
localStorage.removeItem(this.cookie_namespace+cookie);
51+
} else if (sessionStorage.getItem(this.cookie_namespace+cookie)) {
52+
sessionStorage.removeItem(this.cookie_namespace+cookie);
53+
}
54+
} else {
55+
this.writeSetting(cookie,'',-1);
56+
}
57+
},
58+
}

‎api/custom.css‎

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
/**
2+
* MFC Documentation Custom Styles
3+
* Overrides for doxygen-awesome theme
4+
*/
5+
6+
/* Hide empty nav-path footer (kept for navtree.js height calculation) */
7+
#nav-path {
8+
height: 0;
9+
overflow: hidden;
10+
}
11+
12+
/* Cross-navigation panel at top of sidebar */
13+
#mfc-nav {
14+
display: flex;
15+
flex-direction: column;
16+
padding: 10px 12px 8px;
17+
border-bottom: 1px solid var(--separator-color);
18+
background: var(--side-nav-background);
19+
font-size: 0.8rem;
20+
}
21+
22+
#mfc-nav a {
23+
display: block;
24+
padding: 4px 8px;
25+
border-radius: 4px;
26+
color: var(--page-foreground-color);
27+
text-decoration: none;
28+
opacity: 0.75;
29+
transition: background 0.12s, opacity 0.12s;
30+
}
31+
32+
#mfc-nav a:hover {
33+
opacity: 1;
34+
background: var(--side-nav-background-highlight, rgba(0,0,0,0.05));
35+
}
36+
37+
#mfc-nav a.active {
38+
font-weight: 600;
39+
opacity: 1;
40+
color: var(--primary-color);
41+
background: var(--side-nav-background-highlight, rgba(0,0,0,0.05));
42+
}
43+
44+
/* Narrower left navigation panel */
45+
html {
46+
--side-nav-fixed-width: 210px;
47+
}
48+
49+
/* Hide tree sync button */
50+
#nav-sync {
51+
display: none;
52+
}
53+
54+
/* Seamless split <code> tags for Fortran % struct accessors.
55+
* Doxygen consumes %<word> even inside code spans, so we split around %
56+
* into adjacent <code> elements and remove internal borders/padding. */
57+
code.f90l {
58+
border-right: 0;
59+
border-top-right-radius: 0;
60+
border-bottom-right-radius: 0;
61+
padding-right: 0;
62+
}
63+
code.f90r {
64+
border-left: 0;
65+
border-top-left-radius: 0;
66+
border-bottom-left-radius: 0;
67+
padding-left: 0;
68+
}
69+
70+
/* Fix inline code visibility in colored admonition blocks (warning, attention, important, note, etc.) */
71+
72+
/* Warning/Attention/Important blocks (red/pink background) */
73+
dl.warning .tt, dl.attention .tt, dl.important .tt,
74+
dl.warning code, dl.attention code, dl.important code {
75+
background-color: rgba(255, 255, 255, 0.5);
76+
color: #5a0a0f;
77+
border-color: rgba(0, 0, 0, 0.15);
78+
}
79+
80+
/* Note/Remark blocks (yellow/blue background) */
81+
dl.note .tt, dl.remark .tt,
82+
dl.note code, dl.remark code {
83+
background-color: rgba(255, 255, 255, 0.5);
84+
color: #3a3000;
85+
border-color: rgba(0, 0, 0, 0.15);
86+
}
87+
88+
/* Todo blocks (purple background) */
89+
dl.todo .tt, dl.todo code {
90+
background-color: rgba(255, 255, 255, 0.5);
91+
color: #2a1050;
92+
border-color: rgba(0, 0, 0, 0.15);
93+
}
94+
95+
/* Bug blocks */
96+
dl.bug .tt, dl.bug code {
97+
background-color: rgba(255, 255, 255, 0.5);
98+
color: #5a0a0f;
99+
border-color: rgba(0, 0, 0, 0.15);
100+
}
101+
102+
/* Deprecated blocks */
103+
dl.deprecated .tt, dl.deprecated code {
104+
background-color: rgba(255, 255, 255, 0.5);
105+
color: #333;
106+
border-color: rgba(0, 0, 0, 0.15);
107+
}
108+
109+
/* Invariant/Pre/Post blocks */
110+
dl.invariant .tt, dl.pre .tt, dl.post .tt,
111+
dl.invariant code, dl.pre code, dl.post code {
112+
background-color: rgba(255, 255, 255, 0.5);
113+
color: #0a3a5a;
114+
border-color: rgba(0, 0, 0, 0.15);
115+
}
116+
117+
/* Dark mode overrides */
118+
@media (prefers-color-scheme: dark) {
119+
dl.warning .tt, dl.attention .tt, dl.important .tt,
120+
dl.warning code, dl.attention code, dl.important code {
121+
background-color: rgba(0, 0, 0, 0.3);
122+
color: #ffcccc;
123+
border-color: rgba(255, 255, 255, 0.15);
124+
}
125+
126+
dl.note .tt, dl.remark .tt,
127+
dl.note code, dl.remark code {
128+
background-color: rgba(0, 0, 0, 0.3);
129+
color: #cce5ff;
130+
border-color: rgba(255, 255, 255, 0.15);
131+
}
132+
133+
dl.todo .tt, dl.todo code {
134+
background-color: rgba(0, 0, 0, 0.3);
135+
color: #e0d0ff;
136+
border-color: rgba(255, 255, 255, 0.15);
137+
}
138+
139+
dl.bug .tt, dl.bug code {
140+
background-color: rgba(0, 0, 0, 0.3);
141+
color: #ffcccc;
142+
border-color: rgba(255, 255, 255, 0.15);
143+
}
144+
145+
dl.deprecated .tt, dl.deprecated code {
146+
background-color: rgba(0, 0, 0, 0.3);
147+
color: #d0d0d0;
148+
border-color: rgba(255, 255, 255, 0.15);
149+
}
150+
151+
dl.invariant .tt, dl.pre .tt, dl.post .tt,
152+
dl.invariant code, dl.pre code, dl.post code {
153+
background-color: rgba(0, 0, 0, 0.3);
154+
color: #cce5ff;
155+
border-color: rgba(255, 255, 255, 0.15);
156+
}
157+
}
158+
159+
/* doxygen-awesome dark mode class-based detection */
160+
html.dark-mode dl.warning .tt, html.dark-mode dl.attention .tt, html.dark-mode dl.important .tt,
161+
html.dark-mode dl.warning code, html.dark-mode dl.attention code, html.dark-mode dl.important code {
162+
background-color: rgba(0, 0, 0, 0.3);
163+
color: #ffcccc;
164+
border-color: rgba(255, 255, 255, 0.15);
165+
}
166+
167+
html.dark-mode dl.note .tt, html.dark-mode dl.remark .tt,
168+
html.dark-mode dl.note code, html.dark-mode dl.remark code {
169+
background-color: rgba(0, 0, 0, 0.3);
170+
color: #cce5ff;
171+
border-color: rgba(255, 255, 255, 0.15);
172+
}
173+
174+
html.dark-mode dl.todo .tt, html.dark-mode dl.todo code {
175+
background-color: rgba(0, 0, 0, 0.3);
176+
color: #e0d0ff;
177+
border-color: rgba(255, 255, 255, 0.15);
178+
}
179+
180+
html.dark-mode dl.bug .tt, html.dark-mode dl.bug code {
181+
background-color: rgba(0, 0, 0, 0.3);
182+
color: #ffcccc;
183+
border-color: rgba(255, 255, 255, 0.15);
184+
}
185+
186+
html.dark-mode dl.deprecated .tt, html.dark-mode dl.deprecated code {
187+
background-color: rgba(0, 0, 0, 0.3);
188+
color: #d0d0d0;
189+
border-color: rgba(255, 255, 255, 0.15);
190+
}
191+
192+
html.dark-mode dl.invariant .tt, html.dark-mode dl.pre .tt, html.dark-mode dl.post .tt,
193+
html.dark-mode dl.invariant code, html.dark-mode dl.pre code, html.dark-mode dl.post code {
194+
background-color: rgba(0, 0, 0, 0.3);
195+
color: #cce5ff;
196+
border-color: rgba(255, 255, 255, 0.15);
197+
}

0 commit comments

Comments
 (0)