summaryrefslogtreecommitdiff
path: root/api-docs
diff options
context:
space:
mode:
authorkat <kat@vector35.com>2023-05-26 23:15:20 -0400
committerkat <kat@vector35.com>2023-05-26 23:15:33 -0400
commit5e61fe0e0f4cb2e7747acc6f2cd73858d7bfe452 (patch)
tree3a7bae844a5a0d14f7a51ab0865e281db51a5693 /api-docs
parent86b0f8473076eb12c86b710f24140b2e6aaf00c3 (diff)
[C++ Docs] Metadata and DataBuffer docs, and thread safety tags on namespace methods
Diffstat (limited to 'api-docs')
-rw-r--r--api-docs/cppdocs/USEBUILDMINDOCS4
-rw-r--r--api-docs/cppdocs/custom.css21
2 files changed, 23 insertions, 2 deletions
diff --git a/api-docs/cppdocs/USEBUILDMINDOCS b/api-docs/cppdocs/USEBUILDMINDOCS
index e15cfe15..e54da627 100644
--- a/api-docs/cppdocs/USEBUILDMINDOCS
+++ b/api-docs/cppdocs/USEBUILDMINDOCS
@@ -259,7 +259,7 @@ TAB_SIZE = 4
# commands \{ and \} for these it is advised to use the version @{ and @} or use
# a double escape (\\{ and \\})
-ALIASES = threadsafety{1}="<dl class=\"threadsafe \1\"><dt><img class=\"thread\" src=\"thread.png\"> Thread Safe: <dd>\1</dd></dt></dl>" threadsafe="\threadsafety{Yes}" threadunsafe="\threadsafety{No}"
+ALIASES = threadsafety{1}="<dl class=\"threadsafe \1\"><dt><img class=\"thread\" src=\"thread.png\"> Thread Safe: <dd>\1</dd></dt></dl>" threadsafetywith{2}="<dl class=\"threadsafe \1\"><dt title=\"\2\"><img class=\"thread\" src=\"thread.png\"> Thread Safe: <dd>\1</dd></dt></dl>" threadsafe="\threadsafety{Yes}" threadunsafe="\threadsafety{No}" threadunsafewith{1}="\threadsafetywith{No,\1}" threadmainonly="\threadsafety{Main Thread Only}"
# 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
@@ -325,7 +325,7 @@ EXTENSION_MAPPING =
# case of backward compatibilities issues.
# The default value is: YES.
-MARKDOWN_SUPPORT = YES
+MARKDOWN_SUPPORT = NO
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
# to that level are automatically included in the table of contents, even if
diff --git a/api-docs/cppdocs/custom.css b/api-docs/cppdocs/custom.css
index fff8d2dc..7443e5b2 100644
--- a/api-docs/cppdocs/custom.css
+++ b/api-docs/cppdocs/custom.css
@@ -126,6 +126,9 @@ dl.threadsafe {
.threadsafe dt {
padding-right: 35px;
}
+.threadsafe.Main.Thread.Only dt {
+ padding-right: 145px;
+}
.threadsafe.Yes dd {
display: inline!important;
margin-inline-start: 0;
@@ -139,6 +142,7 @@ dl.threadsafe {
width: 25px;
text-align: center;
}
+
.threadsafe.No dd {
display: inline!important;
margin-inline-start: 0;
@@ -153,6 +157,20 @@ dl.threadsafe {
text-align: center;
}
+.threadsafe.Main.Thread.Only dd {
+ display: inline!important;
+ margin-inline-start: 0;
+ position: absolute;
+ top: 1px;
+ right: 1px;
+ padding: 1px 6px 1px 5px;
+ background-color: #d0584d;
+ border-bottom-right-radius: 3px;
+ border-top-right-radius: 3px;
+ width: 135px;
+ text-align: center;
+}
+
.light-mode dl.threadsafe {
background-color: #d0d6e2;
}
@@ -162,6 +180,9 @@ dl.threadsafe {
.light-mode .threadsafe.No dd {
background-color: #fb877d;
}
+.light-mode .threadsafe.Main.Thread.Only dd {
+ background-color: #fb877d;
+}
img.thread {
max-width: 15px;