Skip to content

Commit

Permalink
Update the API reference
Browse files Browse the repository at this point in the history
  • Loading branch information
cedx committed Apr 9, 2023
1 parent bb3d8f7 commit a8f92a5
Show file tree
Hide file tree
Showing 27 changed files with 48 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/404.html → docs/api/404.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!DOCTYPE html><html lang="en"><!-- use theme color or fallback --><!--use textcolor from settings, otherwise create a contrasting color to theme color--><head><meta charset="utf-8"/><link href="./bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="./jquery-1.9.1.min.js"></script><script src="./bootstrap/js/bootstrap.min.js"></script><script src="./bootstrap/js/bootstrap-select.min.js"></script><link href="./styles.css" rel="stylesheet"/><link href="./extra-styles.css" rel="stylesheet"/><link href="./haxe-nav.css" rel="stylesheet"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>File not found - MC2IT Card</title></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>.navbar .brand {display: inline-block;float: none;text-shadow: 0 0 0 transparent;}</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#165898; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#FFFFFF" href="./">MC2IT Card</a><a href="#" id="theme-toggle" class="brand" style="color:#FFFFFF" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><script type="text/javascript">$(document).ready(errorSearch);</script><h1><small>404</small> Page not found</h1><p>Page not found, sorry.</p></div></div></div><footer class="section site-footer" style="background:#165898"><div class="container"><div class="copyright"><p style="color:#FFFFFF">This documentation is generated for version 4.0.0</p><p style="color:#FFFFFF">&copy; 2023 &nbsp;<a style="color:#FFFFFF" href="https://github.com/mc2it/card">https://github.com/mc2it/card</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
<!DOCTYPE html><html lang="en"><!-- use theme color or fallback --><!--use textcolor from settings, otherwise create a contrasting color to theme color--><head><meta charset="utf-8"/><link href="./bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="./jquery-1.9.1.min.js"></script><script src="./bootstrap/js/bootstrap.min.js"></script><script src="./bootstrap/js/bootstrap-select.min.js"></script><link href="./styles.css" rel="stylesheet"/><link href="./extra-styles.css" rel="stylesheet"/><link href="./haxe-nav.css" rel="stylesheet"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>File not found - MC2IT Card</title></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>.navbar .brand {display: inline-block;float: none;text-shadow: 0 0 0 transparent;}</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#165898; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#FFFFFF" href="./">MC2IT Card</a><a href="#" id="theme-toggle" class="brand" style="color:#FFFFFF" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><script type="text/javascript">$(document).ready(errorSearch);</script><h1><small>404</small> Page not found</h1><p>Page not found, sorry.</p></div></div></div><footer class="section site-footer" style="background:#165898"><div class="container"><div class="copyright"><p style="color:#FFFFFF">This documentation is generated for version 4.1.0</p><p style="color:#FFFFFF">&copy; 2023 &nbsp;<a style="color:#FFFFFF" href="https://mc2it.github.io/card">https://mc2it.github.io/card</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 10 additions & 0 deletions docs/api/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<head><meta charset="utf-8"/><link href="./bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="./jquery-1.9.1.min.js"></script><script src="./bootstrap/js/bootstrap.min.js"></script><script src="./bootstrap/js/bootstrap-select.min.js"></script><link href="./styles.css" rel="stylesheet"/><link href="./extra-styles.css" rel="stylesheet"/><link href="./haxe-nav.css" rel="stylesheet"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>mc2it_card - MC2IT Card</title></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#165898; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#FFFFFF" href="./">MC2IT Card</a><a href="#" id="theme-toggle" class="brand" style="color:#FFFFFF" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><h1>mc2it_card <small>version 4.1.0</small></h1><p>Business card of MC2IT, distribution and services.</p> <table class="table table-condensed"><tbody><tr class="abstract"><td style="width:200px;"><a href="./mc2it_card/CardBuilder.html" title=".CardBuilder">CardBuilder</a></td><td><p>Builds a business card by appending string chunks.</p></td></tr></tbody></table></div></div></div><footer class="section site-footer" style="background:#165898"><div class="container"><div class="copyright"><p style="color:#FFFFFF">This documentation is generated for version 4.1.0</p><p style="color:#FFFFFF">&copy; 2023 &nbsp;<a style="color:#FFFFFF" href="https://mc2it.github.io/card">https://mc2it.github.io/card</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#165898; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#FFFFFF" href="../">MC2IT Card</a><a href="#" id="theme-toggle" class="brand" style="color:#FFFFFF" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><span class="viewsource"><a href="https://github.com/mc2it/card/blob/main/src/mc2it_card/CardBuilder.hx" class="btn btn-medium"><i class="fa fa-eye"></i> View source</a></span><h1><small>abstract</small> CardBuilder(<span class="type">StringBuf</span>)</h1><h4><small>package <a href="../index.html">mc2it_card</a></small></h4><h4><small>from <span class="type">StringBuf</span></small></h4><span class="label label-meta label-meta-forward" title="Forwards field access to underlying type.">@:forward(toString)</span></div><div class="body"><div class="doc doc-main"><p>Builds a business card by appending string chunks.</p></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="center"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#center"><span class="identifier">center</span></a>(<span style="white-space:nowrap">this:<span class="type">StringBuf</span>,</span> <span style="white-space:nowrap">text:<span class="type">String</span></span>):<a class="type" title="mc2it_card.CardBuilder - Builds a business card by appending string chunks." href="../mc2it_card/CardBuilder.html">CardBuilder</a></code></h3><div class="doc"><p>Appends a centered line of text.</p></div></div><div class="field "><a name="footer"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#footer"><span class="identifier">footer</span></a>(<span style="white-space:nowrap">this:<span class="type">StringBuf</span></span>):<a class="type" title="mc2it_card.CardBuilder - Builds a business card by appending string chunks." href="../mc2it_card/CardBuilder.html">CardBuilder</a></code></h3><div class="doc"><p>Appends a bottom border.</p></div></div><div class="field "><a name="header"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#header"><span class="identifier">header</span></a>(<span style="white-space:nowrap">this:<span class="type">StringBuf</span></span>):<a class="type" title="mc2it_card.CardBuilder - Builds a business card by appending string chunks." href="../mc2it_card/CardBuilder.html">CardBuilder</a></code></h3><div class="doc"><p>Appends a top border.</p></div></div><div class="field "><a name="label"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#label"><span class="identifier">label</span></a>(<span style="white-space:nowrap">this:<span class="type">StringBuf</span>,</span> <span style="white-space:nowrap">label:<span class="type">String</span>,</span> <span style="white-space:nowrap">value:<span class="type">String</span></span>):<a class="type" title="mc2it_card.CardBuilder - Builds a business card by appending string chunks." href="../mc2it_card/CardBuilder.html">CardBuilder</a></code></h3><div class="doc"><p>Adds a labeled value.</p></div></div><div class="field "><a name="line"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ text : &quot;&quot; })</span><span class="label label-static">static</span><a href="#line"><span class="identifier">line</span></a>(<span style="white-space:nowrap">this:<span class="type">StringBuf</span>,</span> <span style="white-space:nowrap">text:<span class="type">String</span> = &quot;&quot;</span>):<a class="type" title="mc2it_card.CardBuilder - Builds a business card by appending string chunks." href="../mc2it_card/CardBuilder.html">CardBuilder</a></code></h3><div class="doc"><p>Appends a line of text.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#165898"><div class="container"><div class="copyright"><p style="color:#FFFFFF">This documentation is generated for version 4.0.0</p><p style="color:#FFFFFF">&copy; 2023 &nbsp;<a style="color:#FFFFFF" href="https://github.com/mc2it/card">https://github.com/mc2it/card</a></p></div></div></footer><script src="..//highlighter.js"></script><link href="../highlighter.css" rel="stylesheet"/></body></html>
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#165898; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#FFFFFF" href="../">MC2IT Card</a><a href="#" id="theme-toggle" class="brand" style="color:#FFFFFF" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><span class="viewsource"><a href="https://github.com/mc2it/card/blob/main/src/mc2it_card/CardBuilder.hx" class="btn btn-medium"><i class="fa fa-eye"></i> View source</a></span><h1><small>abstract</small> CardBuilder(<span class="type">StringBuf</span>)</h1><h4><small>package <a href="../index.html">mc2it_card</a></small></h4><h4><small>from <span class="type">StringBuf</span></small></h4><span class="label label-meta label-meta-forward" title="Forwards field access to underlying type.">@:forward(toString)</span></div><div class="body"><div class="doc doc-main"><p>Builds a business card by appending string chunks.</p></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="center"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#center"><span class="identifier">center</span></a>(<span style="white-space:nowrap">this:<span class="type">StringBuf</span>,</span> <span style="white-space:nowrap">text:<span class="type">String</span></span>):<a class="type" title="mc2it_card.CardBuilder - Builds a business card by appending string chunks." href="../mc2it_card/CardBuilder.html">CardBuilder</a></code></h3><div class="doc"><p>Appends a centered line of text.</p></div></div><div class="field "><a name="footer"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#footer"><span class="identifier">footer</span></a>(<span style="white-space:nowrap">this:<span class="type">StringBuf</span></span>):<a class="type" title="mc2it_card.CardBuilder - Builds a business card by appending string chunks." href="../mc2it_card/CardBuilder.html">CardBuilder</a></code></h3><div class="doc"><p>Appends a bottom border.</p></div></div><div class="field "><a name="header"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#header"><span class="identifier">header</span></a>(<span style="white-space:nowrap">this:<span class="type">StringBuf</span></span>):<a class="type" title="mc2it_card.CardBuilder - Builds a business card by appending string chunks." href="../mc2it_card/CardBuilder.html">CardBuilder</a></code></h3><div class="doc"><p>Appends a top border.</p></div></div><div class="field "><a name="label"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#label"><span class="identifier">label</span></a>(<span style="white-space:nowrap">this:<span class="type">StringBuf</span>,</span> <span style="white-space:nowrap">label:<span class="type">String</span>,</span> <span style="white-space:nowrap">value:<span class="type">String</span></span>):<a class="type" title="mc2it_card.CardBuilder - Builds a business card by appending string chunks." href="../mc2it_card/CardBuilder.html">CardBuilder</a></code></h3><div class="doc"><p>Adds a labeled value.</p></div></div><div class="field "><a name="line"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ text : &quot;&quot; })</span><span class="label label-static">static</span><a href="#line"><span class="identifier">line</span></a>(<span style="white-space:nowrap">this:<span class="type">StringBuf</span>,</span> <span style="white-space:nowrap">text:<span class="type">String</span> = &quot;&quot;</span>):<a class="type" title="mc2it_card.CardBuilder - Builds a business card by appending string chunks." href="../mc2it_card/CardBuilder.html">CardBuilder</a></code></h3><div class="doc"><p>Appends a line of text.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#165898"><div class="container"><div class="copyright"><p style="color:#FFFFFF">This documentation is generated for version 4.1.0</p><p style="color:#FFFFFF">&copy; 2023 &nbsp;<a style="color:#FFFFFF" href="https://mc2it.github.io/card">https://mc2it.github.io/card</a></p></div></div></footer><script src="..//highlighter.js"></script><link href="../highlighter.css" rel="stylesheet"/></body></html>
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
Loading

0 comments on commit a8f92a5

Please sign in to comment.