removed individual documentation in favor of a master site
This commit is contained in:
parent
aceb7a51db
commit
95895eb377
@ -1,133 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<!-- Documentation generated by LuaDox: https://github.com/jtackaberry/luadox -->
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<title>new_class - LEEF-class</title>
|
||||
<link href="../prism.css?7653a2d" rel="stylesheet" />
|
||||
<link rel="stylesheet" href="../luadox.css?7653a2d" type="text/css">
|
||||
|
||||
</head>
|
||||
<body class="class-new_class">
|
||||
<div class="topbar">
|
||||
<div class="group one">
|
||||
<div class="description"><span>LEEF-class | implementation of classes and immutable tables in lua (for minetest)</span></div>
|
||||
</div>
|
||||
<div class="group two">
|
||||
</div>
|
||||
<div class="group three">
|
||||
</div>
|
||||
</div>
|
||||
<div class="sidebar">
|
||||
<form action="../search.html">
|
||||
<input class="search" name="q" type="search" placeholder="Search" />
|
||||
</form>
|
||||
<div class="sections">
|
||||
<div class="heading">Contents</div>
|
||||
<ul>
|
||||
<li><a href="#new_class">Class <code>new_class</code></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="classes">
|
||||
<div class="heading">Classes</div>
|
||||
<ul>
|
||||
<li class="selected"><a href="../class/new_class.html">new_class.new_class</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="body">
|
||||
<div class="section">
|
||||
<h2 class="class" id="new_class">Class <code>new_class</code>
|
||||
<a class="permalink" href="#new_class" title="Permalink to this definition">¶</a>
|
||||
</h2>
|
||||
<div class="inner">
|
||||
<p>An instantiatable class to inherit for defining new instantiatble classes classes
|
||||
the "base" class. To make a new class call <code>new_class:inherit(your_new_class)</code>.
|
||||
also note that these classes will not have the type "table" but "class".</p>
|
||||
|
||||
<div class="synopsis">
|
||||
<h3>Synopsis</h3>
|
||||
<div class="heading">Fields</div>
|
||||
<table class="fields ">
|
||||
<tr>
|
||||
<td class="name"><a href="#new_class.instance"><var>instance</var></a></td>
|
||||
<td class="doc"><p>defines wether the object is an instance, use this in construction to determine what changes to make</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#new_class.base_class"><var>base_class</var></a></td>
|
||||
<td class="doc"><p>only present for instances: the class from which this instance originates</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#new_class.parent_class"><var>parent_class</var></a></td>
|
||||
<td class="doc"><p>the class from which this class was inherited from</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<div class="heading">Methods</div>
|
||||
<table class="functions ">
|
||||
<tr>
|
||||
<td class="name"><a href="#leef.class.new_class.inherit"><var>leef.class.new_class:inherit</var></a>()</td>
|
||||
<td class="doc"><p>creates a new base class</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name"><a href="#leef.class.new_class.new"><var>leef.class.new_class:new</var></a>()</td>
|
||||
<td class="doc"><p>creates an instance of the base class</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<h3 class="fields">Fields</h3>
|
||||
<dl class="fields">
|
||||
<dt id="new_class.instance">
|
||||
<span class="icon"></span><var>new_class.instance</var>
|
||||
<a class="permalink" href="#new_class.instance" title="Permalink to this definition">¶</a>
|
||||
</dt>
|
||||
<dd>
|
||||
<p>defines wether the object is an instance, use this in construction to determine what changes to make</p>
|
||||
|
||||
</dd>
|
||||
<dt id="new_class.base_class">
|
||||
<span class="icon"></span><var>new_class.base_class</var>
|
||||
<a class="permalink" href="#new_class.base_class" title="Permalink to this definition">¶</a>
|
||||
</dt>
|
||||
<dd>
|
||||
<p>only present for instances: the class from which this instance originates</p>
|
||||
|
||||
</dd>
|
||||
<dt id="new_class.parent_class">
|
||||
<span class="icon"></span><var>new_class.parent_class</var>
|
||||
<a class="permalink" href="#new_class.parent_class" title="Permalink to this definition">¶</a>
|
||||
</dt>
|
||||
<dd>
|
||||
<p>the class from which this class was inherited from</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 class="functions">Methods</h3>
|
||||
<dl class="functions">
|
||||
<dt id="leef.class.new_class.inherit">
|
||||
<span class="icon"></span><var>leef.class.new_class:inherit</var>(<em>def</em>)
|
||||
<a class="permalink" href="#leef.class.new_class.inherit" title="Permalink to this definition">¶</a>
|
||||
</dt>
|
||||
<dd>
|
||||
<p>creates a new base class. Calls all constructors in the chain with def.instance=true</p>
|
||||
|
||||
</dd>
|
||||
<dt id="leef.class.new_class.new">
|
||||
<span class="icon"></span><var>leef.class.new_class:new</var>(<em>def</em>)
|
||||
<a class="permalink" href="#leef.class.new_class.new" title="Permalink to this definition">¶</a>
|
||||
</dt>
|
||||
<dd>
|
||||
<p>creates an instance of the base class. Calls all constructors in the chain with def.instance=true</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="../prism.js?7653a2d"></script>
|
||||
</body>
|
||||
</html>
|
@ -1 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="24" height="24" viewBox="0 0 24 24"><path d="M2.65 3C2.3 3 2 3.3 2 3.65C2 3.69 2 3.73 2 3.77L4.73 20.27C4.8 20.69 5.16 21 5.58 21H18.63C18.94 21 19.22 20.78 19.27 20.46L22 3.77C22.05 3.42 21.81 3.09 21.46 3.04C21.43 3.03 21.39 3.03 21.35 3.03L2.65 3M14.1 14.95H9.94L8.81 9.07H15.11L14.1 14.95Z" /></svg>
|
Before Width: | Height: | Size: 543 B |
@ -1 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="24" height="24" viewBox="0 0 24 24"><path d="M5,20H19V18H5M19,9H15V3H9V9H5L12,16L19,9Z" /></svg>
|
Before Width: | Height: | Size: 336 B |
@ -1 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="24" height="24" viewBox="0 0 24 24"><path d="M12,2A10,10 0 0,0 2,12C2,16.42 4.87,20.17 8.84,21.5C9.34,21.58 9.5,21.27 9.5,21C9.5,20.77 9.5,20.14 9.5,19.31C6.73,19.91 6.14,17.97 6.14,17.97C5.68,16.81 5.03,16.5 5.03,16.5C4.12,15.88 5.1,15.9 5.1,15.9C6.1,15.97 6.63,16.93 6.63,16.93C7.5,18.45 8.97,18 9.54,17.76C9.63,17.11 9.89,16.67 10.17,16.42C7.95,16.17 5.62,15.31 5.62,11.5C5.62,10.39 6,9.5 6.65,8.79C6.55,8.54 6.2,7.5 6.75,6.15C6.75,6.15 7.59,5.88 9.5,7.17C10.29,6.95 11.15,6.84 12,6.84C12.85,6.84 13.71,6.95 14.5,7.17C16.41,5.88 17.25,6.15 17.25,6.15C17.8,7.5 17.45,8.54 17.35,8.79C18,9.5 18.38,10.39 18.38,11.5C18.38,15.32 16.04,16.16 13.81,16.41C14.17,16.72 14.5,17.33 14.5,18.26C14.5,19.6 14.5,20.68 14.5,21C14.5,21.27 14.66,21.59 15.17,21.5C19.14,20.16 22,16.42 22,12A10,10 0 0,0 12,2Z" /></svg>
|
Before Width: | Height: | Size: 1.0 KiB |
@ -1 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="24" height="24" viewBox="0 0 24 24"><path d="M21.94 13.11L20.89 9.89C20.89 9.86 20.88 9.83 20.87 9.8L18.76 3.32C18.65 3 18.33 2.75 17.96 2.75C17.6 2.75 17.28 3 17.17 3.33L15.17 9.5H8.84L6.83 3.33C6.72 3 6.4 2.75 6.04 2.75H6.04C5.67 2.75 5.35 3 5.24 3.33L3.13 9.82C3.13 9.82 3.13 9.83 3.13 9.83L2.06 13.11C1.9 13.61 2.07 14.15 2.5 14.45L11.72 21.16C11.89 21.28 12.11 21.28 12.28 21.15L21.5 14.45C21.93 14.15 22.1 13.61 21.94 13.11M8.15 10.45L10.72 18.36L4.55 10.45M13.28 18.37L15.75 10.78L15.85 10.45H19.46L13.87 17.61M17.97 3.94L19.78 9.5H16.16M14.86 10.45L13.07 15.96L12 19.24L9.14 10.45M6.03 3.94L7.84 9.5H4.23M3.05 13.69C2.96 13.62 2.92 13.5 2.96 13.4L3.75 10.97L9.57 18.42M20.95 13.69L14.44 18.42L14.46 18.39L20.25 10.97L21.04 13.4C21.08 13.5 21.04 13.62 20.95 13.69" /></svg>
|
Before Width: | Height: | Size: 1020 B |
@ -1 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="24" height="24" viewBox="0 0 24 24"><path d="M20,11V13H8L13.5,18.5L12.08,19.92L4.16,12L12.08,4.08L13.5,5.5L8,11H20Z" /></svg>
|
Before Width: | Height: | Size: 365 B |
@ -1 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="24" height="24" viewBox="0 0 24 24"><path d="M4,11V13H16L10.5,18.5L11.92,19.92L19.84,12L11.92,4.08L10.5,5.5L16,11H4Z" /></svg>
|
Before Width: | Height: | Size: 366 B |
@ -1,37 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<!-- Documentation generated by LuaDox: https://github.com/jtackaberry/luadox -->
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<title>Search - LEEF-class</title>
|
||||
<link href="prism.css?7653a2d" rel="stylesheet" />
|
||||
<link rel="stylesheet" href="luadox.css?7653a2d" type="text/css">
|
||||
|
||||
</head>
|
||||
<body class="search-search">
|
||||
<div class="topbar">
|
||||
<div class="group one">
|
||||
<div class="description"><span>LEEF-class | implementation of classes and immutable tables in lua (for minetest)</span></div>
|
||||
</div>
|
||||
<div class="group two">
|
||||
</div>
|
||||
<div class="group three">
|
||||
</div>
|
||||
</div>
|
||||
<div class="sidebar">
|
||||
<form action="search.html">
|
||||
<input class="search" name="q" type="search" placeholder="Search" />
|
||||
</form>
|
||||
<div class="classes">
|
||||
<div class="heading">Classes</div>
|
||||
<ul>
|
||||
<li><a href="class/new_class.html">new_class.new_class</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="body">
|
||||
|
||||
</div>
|
||||
<script src="prism.js?7653a2d"></script>
|
||||
</body>
|
||||
</html>
|
@ -1,8 +0,0 @@
|
||||
var docs = [
|
||||
{path:"class/new_class.html", type:"class", title:"new_class.new_class", text:"An instantiatable class to inherit for defining new instantiatble classes classes the \"base\" class. To make a new class call new_class:inherit(your_new_class). also note that these classes will not have the type \"table\" but \"class\"."},
|
||||
{path:"class/new_class.html#new_class.instance", type:"field", title:"new_class.instance", text:"defines wether the object is an instance, use this in construction to determine what changes to make"},
|
||||
{path:"class/new_class.html#new_class.base_class", type:"field", title:"new_class.base_class", text:"only present for instances: the class from which this instance originates"},
|
||||
{path:"class/new_class.html#new_class.parent_class", type:"field", title:"new_class.parent_class", text:"the class from which this class was inherited from"},
|
||||
{path:"class/new_class.html#leef.class.new_class.inherit", type:"function", title:"leef.class.new_class:inherit", text:"creates a new base class. Calls all constructors in the chain with def.instance=true"},
|
||||
{path:"class/new_class.html#leef.class.new_class.new", type:"function", title:"leef.class.new_class:new", text:"creates an instance of the base class. Calls all constructors in the chain with def.instance=true"},
|
||||
];
|
1
docs/js-search.min.js
vendored
1
docs/js-search.min.js
vendored
File diff suppressed because one or more lines are too long
629
docs/luadox.css
629
docs/luadox.css
@ -1,629 +0,0 @@
|
||||
:target {
|
||||
background-color: #ffe080 !important;
|
||||
color: black !important;
|
||||
border-bottom: 1px solid #cca940 !important;
|
||||
border-top: 1px solid #cca940 !important;
|
||||
}
|
||||
|
||||
body {
|
||||
font-family: sans-serif;
|
||||
color: black;
|
||||
padding: 0px;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
|
||||
div.topbar {
|
||||
box-sizing: border-box;
|
||||
background-color: #465158;
|
||||
position: fixed;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
left: 0px;
|
||||
top: 0px;
|
||||
width: 100%;
|
||||
height: 40px;
|
||||
padding: 0 1em 0 0.4em;
|
||||
z-index: 10;
|
||||
font-size: 90%;
|
||||
color: white;
|
||||
box-shadow: 0 0px 15px 5px rgba(0, 0, 0, 0.4);
|
||||
}
|
||||
|
||||
div.topbar div.group {
|
||||
display: flex;
|
||||
flex: 1;
|
||||
}
|
||||
|
||||
div.topbar div.group.one {
|
||||
justify-content: flex-start;
|
||||
}
|
||||
|
||||
div.topbar div.group.two {
|
||||
justify-content: center;
|
||||
}
|
||||
div.topbar div.group.three {
|
||||
justify-content: flex-end;
|
||||
}
|
||||
|
||||
div.topbar a {
|
||||
color: white;
|
||||
border: none;
|
||||
padding: 0.5em 1em;
|
||||
}
|
||||
|
||||
div.topbar div.description a {
|
||||
font-size: 100% !important;
|
||||
font-weight: normal !important;
|
||||
margin-left: 0 !important;
|
||||
}
|
||||
|
||||
div.topbar div.button a {
|
||||
margin: 0.375em 0;
|
||||
font-size: 80%;
|
||||
font-weight: bold;
|
||||
white-space: nowrap;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
div.topbar div.button.solid a {
|
||||
margin-left: 1em;
|
||||
}
|
||||
|
||||
div.topbar div.button.solid a,
|
||||
div.topbar div.button a:hover {
|
||||
background-color: #697983;
|
||||
text-shadow: 0 1px rgba(0, 0, 0, 0.5);
|
||||
border-radius: 3px;
|
||||
border: none;
|
||||
}
|
||||
div.topbar div.button.solid a:hover {
|
||||
background-color: #8aa0ad;
|
||||
}
|
||||
|
||||
div.topbar div.button a img {
|
||||
width: 1.5em;
|
||||
}
|
||||
|
||||
div.topbar div.button a img[src*='.svg'] {
|
||||
filter: invert(1);
|
||||
}
|
||||
|
||||
div.topbar div.button.iconleft a {
|
||||
padding-left: 0.6em;
|
||||
padding-right: 1em;
|
||||
}
|
||||
|
||||
div.topbar div.button.iconright a {
|
||||
padding-left: 1em;
|
||||
padding-right: 0.6em;
|
||||
}
|
||||
|
||||
div.topbar div.button.iconleft a img {
|
||||
padding-right: 0.5em;
|
||||
}
|
||||
div.topbar div.button.iconright a img {
|
||||
padding-left: 0.5em;
|
||||
}
|
||||
|
||||
div.sidebar {
|
||||
clear: both;
|
||||
box-sizing: border-box;
|
||||
background-color: #e8ecef;
|
||||
width: 15em;
|
||||
height: calc(100% - 40px);
|
||||
padding: 1em 0.5em;
|
||||
border-right: 1px solid #ccc;
|
||||
position: fixed;
|
||||
overflow-y: auto;
|
||||
}
|
||||
|
||||
|
||||
div.body {
|
||||
margin-left: 15em;
|
||||
margin-top: 2.5em;
|
||||
}
|
||||
|
||||
div.sidebar div.heading {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.sidebar ul {
|
||||
list-style-type: none;
|
||||
padding-left: 1em;
|
||||
margin-top: 0.5em;
|
||||
}
|
||||
div.sidebar li {
|
||||
padding: 2px 0;
|
||||
}
|
||||
|
||||
div.sidebar li.selected {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.sidebar div.sections li {
|
||||
padding-left: 1em;
|
||||
text-indent: -1em;
|
||||
}
|
||||
|
||||
div.sidebar p,
|
||||
h2 p {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
display: inline;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #444;
|
||||
text-decoration: none;
|
||||
border-bottom: 1px solid #ccc;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #000;
|
||||
border-bottom: 1px solid #666;
|
||||
}
|
||||
|
||||
div.section, div.body div.manual {
|
||||
padding: 0em 1em 1em 1em;
|
||||
}
|
||||
|
||||
div.body pre {
|
||||
margin: 0 2em;
|
||||
}
|
||||
|
||||
div.manual h1 {
|
||||
margin: 0 -16px 0 -20px;
|
||||
padding: 10px 10px 10px 20px;
|
||||
font-size: 120%;
|
||||
}
|
||||
|
||||
div.section h2 {
|
||||
margin: 0 -16px 0 -20px;
|
||||
padding: 10px 10px 10px 20px;
|
||||
background-color: #eeeeee;
|
||||
border-top: 1px solid #ccc;
|
||||
border-bottom: 1px solid #ccc;
|
||||
font-size: 120%;
|
||||
}
|
||||
|
||||
div.manual h2,
|
||||
div.manual h3 {
|
||||
margin: 1em -16px 0 -20px;
|
||||
padding: 10px 10px 10px 20px;
|
||||
}
|
||||
|
||||
div.manual h2 {
|
||||
background-color: #eeeeee;
|
||||
border-top: 1px solid #ccc;
|
||||
border-bottom: 1px solid #ccc;
|
||||
font-size: 120%;
|
||||
padding: 10px 10px 10px 20px;
|
||||
}
|
||||
|
||||
div.manual h3 {
|
||||
font-size: 110%;
|
||||
padding: 5px 5px 5px 20px;
|
||||
/* Ensures when :target applies (which adds borders) we don't affect layout */
|
||||
border-top: 1px solid transparent;
|
||||
border-bottom: 1px solid transparent;
|
||||
}
|
||||
|
||||
div.hierarchy {
|
||||
margin-top: 2em;
|
||||
margin-bottom: 2em;
|
||||
}
|
||||
|
||||
div.hierarchy div.heading {
|
||||
font-weight: bold;
|
||||
margin-bottom: 0.5em;
|
||||
}
|
||||
div.hierarchy ul {
|
||||
margin-top: 0.5em;
|
||||
padding-left: 1em;
|
||||
}
|
||||
|
||||
div.hierarchy li {
|
||||
list-style-type: none;
|
||||
margin: 0.4em 0;
|
||||
}
|
||||
div.hierarchy li span {
|
||||
padding: 0.2em;
|
||||
font-family: "Consolas", "Deja Vu Sans Mono", "Bitstream Vera Sans Mono", monospace;
|
||||
font-size: 0.95em;
|
||||
letter-spacing: 0.01em;
|
||||
}
|
||||
div.hierarchy li span em {
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
div.hierarchy li.self span {
|
||||
background-color: #fbedc3;
|
||||
}
|
||||
|
||||
h1,
|
||||
div.section h2.class,
|
||||
div.section h2.module {
|
||||
color: white;
|
||||
background-color: #555;
|
||||
border-top: 1px solid #222;
|
||||
border-bottom: 1px solid #222;
|
||||
font-size: 140%;
|
||||
}
|
||||
|
||||
|
||||
code {
|
||||
font-family: 'Courier New', monospace;
|
||||
font-size: 0.95em;
|
||||
}
|
||||
|
||||
var, a code {
|
||||
letter-spacing: 0.01em;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
color: #444;
|
||||
}
|
||||
|
||||
div.see::before {
|
||||
content: "👉 ";
|
||||
}
|
||||
|
||||
h3.fields, h3.functions {
|
||||
padding-top: 1em;
|
||||
padding-bottom: 0.5em !important;
|
||||
}
|
||||
dl p:first-child {
|
||||
margin-top: 0.5em;
|
||||
}
|
||||
dl dd:not(:last-child),
|
||||
dl dd:not(:last-child) {
|
||||
padding-bottom: 1.5em;
|
||||
/*border-bottom: 1px solid #ddd;*/
|
||||
}
|
||||
|
||||
|
||||
dt {
|
||||
padding: 0.5em;
|
||||
margin-left: -1em;
|
||||
margin-right: -1em;
|
||||
/* Ensures when :target applies (which adds borders) we don't affect layout */
|
||||
border-top: 1px solid transparent;
|
||||
border-bottom: 1px solid transparent;
|
||||
}
|
||||
dt var {
|
||||
font-size: 1.15em;
|
||||
}
|
||||
dd {
|
||||
margin-left: 2.5em;
|
||||
}
|
||||
|
||||
dl.functions div.heading {
|
||||
margin-top: 1em;
|
||||
margin-left: 0em;
|
||||
margin-bottom: 0.5em;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
|
||||
table.parameters,
|
||||
table.returns {
|
||||
max-width: 90%;
|
||||
border-top: 1px solid #ccc;
|
||||
border-bottom: 1px solid #ccc;
|
||||
border-left: transparent;
|
||||
border-right: transparent;
|
||||
margin-left: 1em;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.parameters td,
|
||||
table.returns td {
|
||||
padding: 0.4em 0;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
table.parameters tr:not(:last-child) td,
|
||||
table.returns tr:not(:last-child) td {
|
||||
border-bottom: 1px solid #ccc;
|
||||
}
|
||||
|
||||
table.parameters tr,
|
||||
table.returns tr {
|
||||
background: #f7f7f7;
|
||||
}
|
||||
|
||||
|
||||
table.parameters tr td:first-child,
|
||||
table.returns tr td:first-child {
|
||||
text-align: right;
|
||||
padding-left: 1em;
|
||||
}
|
||||
|
||||
table.parameters tr td:last-child,
|
||||
table.returns tr td:last-child {
|
||||
padding-right: 1em;
|
||||
}
|
||||
|
||||
table.parameters td.name,
|
||||
table.parameters td.types,
|
||||
table.returns td.name,
|
||||
table.returns td.types {
|
||||
white-space: nowrap;
|
||||
padding-right: 1em !important;
|
||||
}
|
||||
|
||||
|
||||
* {
|
||||
scroll-padding-top: 40px;
|
||||
}
|
||||
|
||||
div.section div.inner {
|
||||
min-width: 20em;
|
||||
max-width: 80em;
|
||||
}
|
||||
|
||||
div.synopsis h3 {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.synopsis div.heading {
|
||||
font-weight: bold;
|
||||
margin-top: 1em;
|
||||
margin-bottom: 0em;
|
||||
margin-left: 0.5em;
|
||||
}
|
||||
|
||||
div.synopsis table {
|
||||
border-top: 1px solid #d2b089;
|
||||
border-bottom: 1px solid #d2b089;
|
||||
background-color: #f8f0e6;
|
||||
width: 95%;
|
||||
margin: 1em auto;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
div.synopsis td {
|
||||
padding: 0.3em 0.5em 0.3em 0.5em;
|
||||
vertical-align: top;
|
||||
}
|
||||
div.synopsis tr:not(:last-child) td {
|
||||
border-bottom: 1px solid #e2d0ba;
|
||||
}
|
||||
|
||||
div.synopsis td:first-child {
|
||||
/* min-width: 15em;
|
||||
max-width: 20em; */
|
||||
white-space: nowrap;
|
||||
padding-right: 1em;
|
||||
}
|
||||
|
||||
div.synopsis td.meta,
|
||||
div.synopsis td.meta a {
|
||||
white-space: nowrap;
|
||||
color: #777777;
|
||||
}
|
||||
|
||||
div.synopsis td > p,
|
||||
table.parameters td > p,
|
||||
table.returns td > p {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.synopsis td > p:not(:first-child) {
|
||||
margin-top: 0.5em;
|
||||
}
|
||||
|
||||
div.synopsis td a.permalink {
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
|
||||
div.admonition {
|
||||
border: 1px solid #609060;
|
||||
background-color: #e9ffe9;
|
||||
width: 90%;
|
||||
margin: 1.5em auto;
|
||||
}
|
||||
|
||||
div.admonition div.title {
|
||||
margin: 0;
|
||||
margin-top: 0px;
|
||||
padding: 0.3em 0 0.3em 0.5em;
|
||||
color: white;
|
||||
font-weight: bold;
|
||||
font-size: 1.0em;
|
||||
text-shadow: 0 1px rgba(0, 0, 0, 0.5);
|
||||
}
|
||||
|
||||
div.admonition div.body {
|
||||
margin: 0.5em 1em 0.5em 1em;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
|
||||
div.warning {
|
||||
border: 1px solid #900000;
|
||||
background-color: #ffe9e9;
|
||||
}
|
||||
|
||||
div.warning div.title {
|
||||
background-color: #b04040;
|
||||
border-bottom: 1px solid #900000;
|
||||
}
|
||||
|
||||
div.note div.title {
|
||||
background-color: #70A070;
|
||||
border-bottom: 1px solid #609060;
|
||||
}
|
||||
|
||||
dl.fields dt span.icon::after {
|
||||
content: "🏷️ ";
|
||||
vertical-align: middle;
|
||||
font-size: 110%;
|
||||
}
|
||||
|
||||
dl.fields dt span.tag,
|
||||
dl.functions dt span.tag {
|
||||
border-radius: 20px;
|
||||
border: 1px solid #ccc;
|
||||
background-color: #eee;
|
||||
display: inline;
|
||||
opacity: 0.6;
|
||||
padding: 5px 10px;
|
||||
font-size: 80%;
|
||||
margin: 0 0.5em;
|
||||
}
|
||||
|
||||
dl.fields dt span.tag:first-of-type,
|
||||
dl.functions dt span.tag:first-of-type {
|
||||
margin-left: 2em;
|
||||
}
|
||||
|
||||
dl.fields dt span.meta::before,
|
||||
dl.functions dt span.meta::before {
|
||||
filter: saturate(0);
|
||||
opacity: 0.9;
|
||||
content: "👁️";
|
||||
padding-right: 0.5em;
|
||||
}
|
||||
|
||||
dl.fields dt span.type::before {
|
||||
filter: saturate(0);
|
||||
opacity: 0.9;
|
||||
content: "✏️";
|
||||
padding-right: 0.5em;
|
||||
}
|
||||
|
||||
dl.functions dt span.icon::after {
|
||||
content: "🏃♂️ ";
|
||||
vertical-align: middle;
|
||||
font-size: 140%;
|
||||
}
|
||||
|
||||
a.permalink:hover {
|
||||
color: #c60f0f !important;
|
||||
border: none;
|
||||
}
|
||||
|
||||
a.permalink {
|
||||
color: #ccc;
|
||||
font-size: 1em;
|
||||
margin-left: 6px;
|
||||
padding: 0 4px 0 4px;
|
||||
text-decoration: none;
|
||||
border: none;
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
h1:hover > a.permalink,
|
||||
h2:hover > a.permalink,
|
||||
h3:hover > a.permalink,
|
||||
h4:hover > a.permalink,
|
||||
td:hover > a.permalink,
|
||||
td:hover > div > a.permalink,
|
||||
dt:hover > a.permalink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
pre.language-lua {
|
||||
border-radius: 6px;
|
||||
}
|
||||
|
||||
dd table {
|
||||
}
|
||||
|
||||
input.search {
|
||||
width: calc(100% - 2.5em);
|
||||
opacity: 0.7;
|
||||
margin: 0 1em 1em 1em;
|
||||
}
|
||||
|
||||
input.search:focus {
|
||||
opacity: 1.0;
|
||||
}
|
||||
|
||||
div#template {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div#results {
|
||||
padding: 1em;
|
||||
max-width: 650px;
|
||||
}
|
||||
|
||||
div.result {
|
||||
margin-bottom: 35px;
|
||||
font-family: arial, sans-serif;
|
||||
}
|
||||
|
||||
div.result div.title {
|
||||
font-size: 20px;
|
||||
line-height: 1.3;
|
||||
}
|
||||
|
||||
div.result div.text {
|
||||
line-height: 1.58;
|
||||
margin-left: 2em;
|
||||
}
|
||||
|
||||
div.summary {
|
||||
color: #666666;
|
||||
font-size: 90%;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
div.result span {
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
div.result.result-class span::after {
|
||||
content: "🧱 ";
|
||||
}
|
||||
div.result.result-module span::after {
|
||||
content: "📦 ";
|
||||
}
|
||||
div.result.result-field span::after {
|
||||
content: "🏷️ ";
|
||||
}
|
||||
div.result.result-function span::after {
|
||||
content: "🏃♂️ ";
|
||||
}
|
||||
div.result.result-section span::after {
|
||||
content: "📓 ";
|
||||
}
|
||||
div.result b {
|
||||
background-color: #faffb8;
|
||||
}
|
||||
|
||||
table.user {
|
||||
border-collapse: collapse;
|
||||
margin: 1em;
|
||||
font-family: sans-serif;
|
||||
min-width: 400px;
|
||||
box-shadow: 0 0 20px rgba(0, 0, 0, 0.15);
|
||||
border-radius: 10px;
|
||||
border-collapse: collapse;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
table.user thead tr {
|
||||
background-color: #3a5e75;
|
||||
color: #ffffff;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
table.user th,
|
||||
table.user td {
|
||||
padding: 12px 15px;
|
||||
}
|
||||
|
||||
table.user tbody tr {
|
||||
border-bottom: 1px solid #dddddd;
|
||||
}
|
||||
|
||||
table.user tbody tr:nth-of-type(even) {
|
||||
background-color: #f3f3f3;
|
||||
}
|
||||
|
||||
table.user tbody tr:last-of-type {
|
||||
border-bottom: 3px solid #3a5e75;
|
||||
}
|
125
docs/prism.css
125
docs/prism.css
@ -1,125 +0,0 @@
|
||||
/* PrismJS 1.24.1
|
||||
https://prismjs.com/download.html#themes=prism-tomorrow&languages=lua */
|
||||
/**
|
||||
* prism.js tomorrow night eighties for JavaScript, CoffeeScript, CSS and HTML
|
||||
* Based on https://github.com/chriskempson/tomorrow-theme
|
||||
* @author Rose Pritchard
|
||||
*/
|
||||
|
||||
code[class*="language-"],
|
||||
pre[class*="language-"] {
|
||||
color: #ccc;
|
||||
background: none;
|
||||
font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
|
||||
font-size: 1em;
|
||||
text-align: left;
|
||||
white-space: pre;
|
||||
word-spacing: normal;
|
||||
word-break: normal;
|
||||
word-wrap: normal;
|
||||
line-height: 1.5;
|
||||
|
||||
-moz-tab-size: 4;
|
||||
-o-tab-size: 4;
|
||||
tab-size: 4;
|
||||
|
||||
-webkit-hyphens: none;
|
||||
-moz-hyphens: none;
|
||||
-ms-hyphens: none;
|
||||
hyphens: none;
|
||||
|
||||
}
|
||||
|
||||
/* Code blocks */
|
||||
pre[class*="language-"] {
|
||||
padding: 1em;
|
||||
margin: .5em 0;
|
||||
overflow: auto;
|
||||
}
|
||||
|
||||
:not(pre) > code[class*="language-"],
|
||||
pre[class*="language-"] {
|
||||
background: #2d2d2d;
|
||||
}
|
||||
|
||||
/* Inline code */
|
||||
:not(pre) > code[class*="language-"] {
|
||||
padding: .1em;
|
||||
border-radius: .3em;
|
||||
white-space: normal;
|
||||
}
|
||||
|
||||
.token.comment,
|
||||
.token.block-comment,
|
||||
.token.prolog,
|
||||
.token.doctype,
|
||||
.token.cdata {
|
||||
color: #999;
|
||||
}
|
||||
|
||||
.token.punctuation {
|
||||
color: #ccc;
|
||||
}
|
||||
|
||||
.token.tag,
|
||||
.token.attr-name,
|
||||
.token.namespace,
|
||||
.token.deleted {
|
||||
color: #e2777a;
|
||||
}
|
||||
|
||||
.token.function-name {
|
||||
color: #6196cc;
|
||||
}
|
||||
|
||||
.token.boolean,
|
||||
.token.number,
|
||||
.token.function {
|
||||
color: #f08d49;
|
||||
}
|
||||
|
||||
.token.property,
|
||||
.token.class-name,
|
||||
.token.constant,
|
||||
.token.symbol {
|
||||
color: #f8c555;
|
||||
}
|
||||
|
||||
.token.selector,
|
||||
.token.important,
|
||||
.token.atrule,
|
||||
.token.keyword,
|
||||
.token.builtin {
|
||||
color: #cc99cd;
|
||||
}
|
||||
|
||||
.token.string,
|
||||
.token.char,
|
||||
.token.attr-value,
|
||||
.token.regex,
|
||||
.token.variable {
|
||||
color: #7ec699;
|
||||
}
|
||||
|
||||
.token.operator,
|
||||
.token.entity,
|
||||
.token.url {
|
||||
color: #67cdcc;
|
||||
}
|
||||
|
||||
.token.important,
|
||||
.token.bold {
|
||||
font-weight: bold;
|
||||
}
|
||||
.token.italic {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.token.entity {
|
||||
cursor: help;
|
||||
}
|
||||
|
||||
.token.inserted {
|
||||
color: green;
|
||||
}
|
||||
|
File diff suppressed because one or more lines are too long
@ -1,43 +0,0 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<!-- Documentation generated by LuaDox: https://github.com/jtackaberry/luadox -->
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<title>Search - LEEF-class</title>
|
||||
<link href="prism.css?7653a2d" rel="stylesheet" />
|
||||
<link rel="stylesheet" href="luadox.css?7653a2d" type="text/css">
|
||||
|
||||
</head>
|
||||
<body class="search-search">
|
||||
<div class="topbar">
|
||||
<div class="group one">
|
||||
<div class="description"><span>LEEF-class | implementation of classes and immutable tables in lua (for minetest)</span></div>
|
||||
</div>
|
||||
<div class="group two">
|
||||
</div>
|
||||
<div class="group three">
|
||||
</div>
|
||||
</div>
|
||||
<div class="sidebar">
|
||||
<form action="search.html">
|
||||
<input class="search" name="q" type="search" placeholder="Search" />
|
||||
</form>
|
||||
<div class="classes">
|
||||
<div class="heading">Classes</div>
|
||||
<ul>
|
||||
<li><a href="class/new_class.html">new_class.new_class</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="body">
|
||||
<div id="template" class="result"><div class="title"><span></span><a href=""></a></div><div class="text"></div></div>
|
||||
<div id="results">
|
||||
<noscript>⛔ Javascript is required for search functionality.</noscript>
|
||||
<div class="summary"></div>
|
||||
<script src="js-search.min.js?7653a2d"></script>
|
||||
<script src="index.js?7653a2d"></script>
|
||||
<script src="search.js?7653a2d"></script>
|
||||
</div>
|
||||
<script src="prism.js?7653a2d"></script>
|
||||
</body>
|
||||
</html>
|
@ -1,48 +0,0 @@
|
||||
document.addEventListener("DOMContentLoaded", function() {
|
||||
var template = document.getElementById('template');
|
||||
var body = document.getElementById('results');
|
||||
var params = new URLSearchParams(window.location.search);
|
||||
var q = params.get('q');
|
||||
if (!q) {
|
||||
return;
|
||||
}
|
||||
var jss = new JsSearch.Search('title');
|
||||
jss.tokenizer = new JsSearch.StopWordsTokenizer(new JsSearch.SimpleTokenizer());
|
||||
jss.addIndex('title');
|
||||
jss.addIndex('text');
|
||||
jss.addDocuments(docs);
|
||||
var results = jss.search(q);
|
||||
var summary = document.getElementsByClassName('summary')[0];
|
||||
summary.innerHTML = results.length + ' results found for "<i>' + q + '</i>"';
|
||||
var words = q.split(' ');
|
||||
for (var i = 0; i < results.length; i++) {
|
||||
var result = results[i];
|
||||
var clone = template.cloneNode(true);
|
||||
clone.removeAttribute('id');
|
||||
clone.classList.add("result-" + result.type);
|
||||
var title = clone.childNodes[0];
|
||||
var icon = title.childNodes[0];
|
||||
var link = title.childNodes[1];
|
||||
var text = result.text;
|
||||
var title = result.title;
|
||||
if (text.length > 200) {
|
||||
text = text.slice(0, 210);
|
||||
var n = text.lastIndexOf(' ');
|
||||
if (n >= 0) {
|
||||
text = text.slice(0, n);
|
||||
}
|
||||
text = text + ' ...';
|
||||
}
|
||||
// Bold search terms from text
|
||||
for (var j = 0; j < words.length; j++) {
|
||||
text = text.replace(new RegExp('(' + words[j] + ')', 'i'), '<b>$1</b>');
|
||||
title = title.replace(new RegExp('(' + words[j] + ')', 'i'), '<b>$1</b>');
|
||||
}
|
||||
icon.setAttribute('title', result.type);
|
||||
link.setAttribute('href', result.path);
|
||||
link.innerHTML = title + (result.type == 'function' ? "()" : "");
|
||||
var desc = clone.childNodes[1];
|
||||
desc.innerHTML = text;
|
||||
body.appendChild(clone);
|
||||
}
|
||||
});
|
Binary file not shown.
@ -1,27 +0,0 @@
|
||||
[project]
|
||||
# Project name that is displayed on the top bar of each page
|
||||
name = LEEF-class | implementation of classes and immutable tables in lua (for minetest)
|
||||
# HTML title that is appended to every page. If not defined, name is used.
|
||||
title = LEEF-class
|
||||
# A list of files or directories for LuaDox to parse. Globs are supported.
|
||||
# This can be spread across multiple lines if you want, as long as the
|
||||
# other lines are indented.
|
||||
files = ../../*.lua
|
||||
# The directory containing the rendered output files, which will be created
|
||||
# if necessary.
|
||||
outdir = ../../docs
|
||||
# Path to a custom css file that will be included on every page. This will
|
||||
# be copied into the outdir.
|
||||
# css = custom.css
|
||||
# Path to a custom favicon. This will be copied into the outdir.
|
||||
# favicon = img/favicon.png
|
||||
# If require()d files discovered in source should also be parsed.
|
||||
follow = true
|
||||
|
||||
[manual]
|
||||
# Custom manual pages in the form: id = filename.
|
||||
#
|
||||
# The ids must not conflict with any class or module name otherwise references
|
||||
# will not properly resolve.
|
||||
# index = intro.md
|
||||
# tutorial = tut.md
|
@ -1,4 +0,0 @@
|
||||
::literally just so I dont have to open powershell every time.
|
||||
::python 3.8+ required.
|
||||
@echo off
|
||||
python ./luadox -c ./luadox.conf
|
Loading…
x
Reference in New Issue
Block a user