Ikarus/libikarus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

finalise interface & documentation

Browse source 
Signed-off-by: Folling <mail@folling.io>
This commit is contained in:
folling 2023-11-06 13:14:39 +01:00 • committed by Folling
parent c5157bd849
commit 52580a4382
Signed by: folling
SSH key fingerprint: SHA256:S9qEx5WCFFLK49tE/LKnKuJYM5sw+++Dn6qJbbyxnCY
56 changed files with 2074 additions and 780 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/DoxyFile
View file

@ -6,11 +6,14 @@ FULL_SIDEBAR = NO
GENERATE_LATEX = NO
GENERATE_TREEVIEW = YES
HTML_COLORSTYLE = LIGHT # required with Doxygen >= 1.9.5
HTML_EXTRA_FILES = ../vendor/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js ../vendor/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js ./enum_format_fix.js
HTML_EXTRA_FILES = ../vendor/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js ../vendor/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js ./format_fix.js
HTML_EXTRA_STYLESHEET = ../vendor/doxygen-awesome-css/doxygen-awesome.css
HTML_HEADER = header.html
INPUT = ..
OUTPUT_DIRECTORY = generated
PROJECT_BRIEF = A C-API implementation for Ikarus, a tool for worldbuilding.
PROJECT_NAME = LIBIKARUS
RECURSIVE = YES
RECURSIVE = YES
SORT_BRIEF_DOCS = NO
SORT_MEMBER_DOCS = NO
EXTRACT_PRIVATE = NO

11
docs/enum_format_fix.js
View file

@ -1,11 +0,0 @@
// maximum efficiency
function enumFormatFix() {
Array.from(document.getElementsByClassName("memItemRight")).forEach((elem) => {
elem.innerHTML = elem.innerHTML.replaceAll("<br>", "");
elem.innerHTML = elem.innerHTML.replaceAll("&nbsp;", "");
elem.innerHTML = elem.innerHTML.replaceAll("{", "{<br>&nbsp;&nbsp;&nbsp;&nbsp;");
elem.innerHTML = elem.innerHTML.replaceAll("\n,", ",");
elem.innerHTML = elem.innerHTML.replaceAll(",", ",<br>&nbsp;&nbsp;&nbsp;&nbsp;");
elem.innerHTML = elem.innerHTML.replaceAll("}", "<br>}");
});
}

68
docs/format_fix.js Normal file
View file

@ -0,0 +1,68 @@
// maximum efficiency
function enumFormatFix() {
Array.from(document.getElementsByClassName("memItemRight")).forEach((elem) => {
if (elem.innerHTML.includes("{")) {
let str = elem.innerHTML;
str = str.replaceAll("<br>", "");
str = str.replaceAll("&nbsp;", "");
str = str.replaceAll("{", "{<br>&nbsp;&nbsp;&nbsp;&nbsp;");
str = str.replaceAll("\n,", ",");
str = str.replaceAll(",", ",<br>&nbsp;&nbsp;&nbsp;&nbsp;");
str = str.replaceAll("}", "<br>}");
elem.innerHTML = str
}
});
}
function paramFormatFix() {
Array.from(document.getElementsByClassName("memItemRight")).forEach((elem) => {
if (elem.innerHTML.includes("(")) {
let str = elem.innerHTML;
let res = "";
let bracket_level = 0;
let hit_comma = false;
for (let c of str) {
let new_hit_comma = false;
if (c === '(') {
if (bracket_level === 0) {
res += "(<br>&nbsp;&nbsp;&nbsp;&nbsp;";
} else {
res += '(';
}
bracket_level++;
} else if (c === ')') {
if (bracket_level === 1) {
res += "<br>)";
} else {
res += ')';
}
bracket_level--;
} else if (c === ',') {
if (bracket_level === 1) {
res += ",<br>&nbsp;&nbsp;&nbsp;&nbsp;";
} else {
res += ',';
}
new_hit_comma = true;
} else if (c === ' ' && hit_comma && bracket_level === 1) {
new_hit_comma = false;
// skip this space
} else {
res += c;
}
hit_comma = new_hit_comma;
}
elem.innerHTML = res
}
});
}

3
docs/header.html
View file

@ -29,10 +29,11 @@
<script type="text/javascript">
DoxygenAwesomeParagraphLink.init()
</script>
<script type="text/javascript" src="$relpath^enum_format_fix.js"></script>
<script type="text/javascript" src="$relpath^format_fix.js"></script>
<script type="text/javascript">
window.onload = function () {
enumFormatFix()
paramFormatFix()
}
</script>
$treeview