Removed generated documentation

Removed documentation, users should generate it on-the-fly if needed. This is to keep the codebase in a consistent state. If the code is changed, the documentation must be chagned too, otherwise it is possible to see the codebase with old documentation. Additionally, updaing documentation with changes to the codebase would clutter diffs.
author: Alexander Pickering <alex@cogarr.net> 2018-10-31 12:47:37 -0400
committer: Alexander Pickering <alex@cogarr.net> 2018-10-31 12:49:47 -0400
commit: 8291075aeaf614c2f8dc0a0f4c199fd4a0d45cdd (patch)
tree: abc3c3a34eb832aea868bd5114d888a9e3c15dfa /doc
parent: 9e9be703c8f1c58c76fd2051dd6fa6ce49a7a306 (diff)
download: brokengine-8291075aeaf614c2f8dc0a0f4c199fd4a0d45cdd.tar.gz
brokengine-8291075aeaf614c2f8dc0a0f4c199fd4a0d45cdd.tar.bz2
brokengine-8291075aeaf614c2f8dc0a0f4c199fd4a0d45cdd.zip
5 files changed, 1 insertions, 807 deletions
diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 0000000..8d98f9d
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1 @@
+.*
diff --git a/doc/index.html b/doc/index.html
deleted file mode 100644
index 517b2c9..0000000
--- a/doc/index.html
+++ /dev/null
@@ -1,423 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html>
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
-<head>
-    <title>Reference</title>
-    <link rel="stylesheet" href="ldoc.css" type="text/css" />
-</head>
-<body>
-
-<div id="container">
-
-<div id="product">
-	<div id="product_logo"></div>
-	<div id="product_name"><big><b></b></big></div>
-	<div id="product_description"></div>
-</div> <!-- id="product" -->
-
-
-<div id="main">
-
-
-<!-- Menu -->
-
-<div id="navigation">
-<br/>
-<h1>Brok[en]gine</h1>
-
-
-<h2>Contents</h2>
-<ul>
-<li><a href="#Functions">Functions</a></li>
-<li><a href="#Tables">Tables</a></li>
-</ul>
-
-
-<h2>Modules</h2>
-<ul class="nowrap">
-  <li><strong>net</strong></li>
-</ul>
-<h2>Topics</h2>
-<ul class="">
-  <li><a href="topics/readme.md.html">readme</a></li>
-</ul>
-
-</div>
-
-<div id="content">
-
-<h1>Module <code>net</code></h1>
-<p>The net library
-Exposes various structs, constants, and functions for passing messages</p>
-<p></p>
-
-
-<h2><a href="#Functions">Functions</a></h2>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#stream:readint">stream:readint ()</a></td>
-	<td class="summary">Read an integer from the stream</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#stream:readdouble">stream:readdouble ()</a></td>
-	<td class="summary">Read double percision float from the stream</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#stream:readdata">stream:readdata (size)</a></td>
-	<td class="summary">Read some data from the stream</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#stream:readstring">stream:readstring ()</a></td>
-	<td class="summary">Read a string from the stream</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#stream:writeint">stream:writeint (i)</a></td>
-	<td class="summary">Write an integer to the stream</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#stream:writedouble">stream:writedouble (d)</a></td>
-	<td class="summary">Write a double percision float to the stream</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#stream:writedata">stream:writedata (d)</a></td>
-	<td class="summary">Write some data to the stream</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#stream:writestring">stream:writestring (s)</a></td>
-	<td class="summary">Write a string to the stream</td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#socket:bind">socket:bind (where)</a></td>
-	<td class="summary"></td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#receive">receive (message, callback)</a></td>
-	<td class="summary"></td>
-	</tr>
-	<tr>
-	<td class="name" nowrap><a href="#newsocket">newsocket ()</a></td>
-	<td class="summary"></td>
-	</tr>
-</table>
-<h2><a href="#Tables">Tables</a></h2>
-<table class="function_list">
-	<tr>
-	<td class="name" nowrap><a href="#socket">socket</a></td>
-	<td class="summary"></td>
-	</tr>
-</table>
-
-<br/>
-<br/>
-
-
-    <h2 class="section-header "><a name="Functions"></a>Functions</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "stream:readint"></a>
-    <strong>stream:readint ()</strong>
-    </dt>
-    <dd>
-    Read an integer from the stream
-
-    </ul>
-
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">number</span></span>
-        The number read from the stream
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "stream:readdouble"></a>
-    <strong>stream:readdouble ()</strong>
-    </dt>
-    <dd>
-    Read double percision float from the stream
-
-    </ul>
-
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">number</span></span>
-        The number read from the stream
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "stream:readdata"></a>
-    <strong>stream:readdata (size)</strong>
-    </dt>
-    <dd>
-    Read some data from the stream
-
-    </ul>
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">size</span>
-            <span class="types"><span class="type">number</span></span>
-         The size of the data to read from the stream
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
-        The data read from the stream
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "stream:readstring"></a>
-    <strong>stream:readstring ()</strong>
-    </dt>
-    <dd>
-    Read a string from the stream
-
-    </ul>
-
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
-        The string read from the stream
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "stream:writeint"></a>
-    <strong>stream:writeint (i)</strong>
-    </dt>
-    <dd>
-    Write an integer to the stream
-
-    </ul>
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">i</span>
-            <span class="types"><span class="type">number</span></span>
-         The integer to write to the stream
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "stream:writedouble"></a>
-    <strong>stream:writedouble (d)</strong>
-    </dt>
-    <dd>
-    Write a double percision float to the stream
-
-    </ul>
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">d</span>
-            <span class="types"><span class="type">number</span></span>
-         The number to write to the stream
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "stream:writedata"></a>
-    <strong>stream:writedata (d)</strong>
-    </dt>
-    <dd>
-    Write some data to the stream
-
-    </ul>
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">d</span>
-            <span class="types"><span class="type">number</span></span>
-         The number to write to the stream
-        </li>
-    </ul>
-
-    <h3>Returns:</h3>
-    <ol>
-
-           <span class="types"><span class="type">number</span></span>
-        The number of bytes written to the stream
-    </ol>
-
-
-
-
-</dd>
-    <dt>
-    <a name = "stream:writestring"></a>
-    <strong>stream:writestring (s)</strong>
-    </dt>
-    <dd>
-    Write a string to the stream
-
-    </ul>
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">s</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
-         The string to the stream
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "socket:bind"></a>
-    <strong>socket:bind (where)</strong>
-    </dt>
-    <dd>
-
-
-    </ul>
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">where</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
-         Where to connect this socket to
-        </li>
-    </ul>
-
-
-
-
-    <h3>Usage:</h3>
-    <ul>
-        <pre class="example"><span class="keyword">local</span> s = net.newsocket()
-s:bind(<span class="string">"127.0.0.1"</span>)
-s:receive(<span class="string">"ping"</span>,<span class="keyword">function</span>(stream)
-	<span class="global">print</span>(instream:readstring())
-<span class="keyword">end</span>)
-<span class="keyword">local</span> c = net.newsocket()
-c:connect(<span class="string">"127.0.0.1"</span>)</pre>
-    </ul>
-
-</dd>
-    <dt>
-    <a name = "receive"></a>
-    <strong>receive (message, callback)</strong>
-    </dt>
-    <dd>
-
-
-    </ul>
-
-    <h3>Parameters:</h3>
-    <ul>
-        <li><span class="parameter">message</span>
-            <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
-         The message to bind this function to
-        </li>
-        <li><span class="parameter">callback</span>
-            <span class="types"><span class="type">function</span></span>
-         The function to call when this message is received
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-    <dt>
-    <a name = "newsocket"></a>
-    <strong>newsocket ()</strong>
-    </dt>
-    <dd>
-
-
-    <h3>domain:</h3>
-    <ul>
-         shared
-    </ul>
-
-
-    <h3>Returns:</h3>
-    <ol>
-
-        net.socket
-    </ol>
-
-
-
-
-</dd>
-</dl>
-    <h2 class="section-header "><a name="Tables"></a>Tables</h2>
-
-    <dl class="function">
-    <dt>
-    <a name = "socket"></a>
-    <strong>socket</strong>
-    </dt>
-    <dd>
-
-
-    <h3>domain:</h3>
-    <ul>
-         shared
-    </ul>
-
-    <h3>Fields:</h3>
-    <ul>
-        <li><span class="parameter">fd</span>
-
-        </li>
-    </ul>
-
-
-
-
-
-</dd>
-</dl>
-
-
-</div> <!-- id="content" -->
-</div> <!-- id="main" -->
-<div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2018-07-03 16:38:22 </i>
-</div> <!-- id="about" -->
-</div> <!-- id="container" -->
-</body>
-</html>
diff --git a/doc/ldoc.css b/doc/ldoc.css
deleted file mode 100644
index 52c4ad2..0000000
--- a/doc/ldoc.css
+++ /dev/null
@@ -1,303 +0,0 @@
-/* BEGIN RESET
-
-Copyright (c) 2010, Yahoo! Inc. All rights reserved.
-Code licensed under the BSD License:
-http://developer.yahoo.com/yui/license.html
-version: 2.8.2r1
-*/
-html {
-    color: #000;
-    background: #FFF;
-}
-body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td {
-    margin: 0;
-    padding: 0;
-}
-table {
-    border-collapse: collapse;
-    border-spacing: 0;
-}
-fieldset,img {
-    border: 0;
-}
-address,caption,cite,code,dfn,em,strong,th,var,optgroup {
-    font-style: inherit;
-    font-weight: inherit;
-}
-del,ins {
-    text-decoration: none;
-}
-li {
-    margin-left: 20px;
-}
-caption,th {
-    text-align: left;
-}
-h1,h2,h3,h4,h5,h6 {
-    font-size: 100%;
-    font-weight: bold;
-}
-q:before,q:after {
-    content: '';
-}
-abbr,acronym {
-    border: 0;
-    font-variant: normal;
-}
-sup {
-    vertical-align: baseline;
-}
-sub {
-    vertical-align: baseline;
-}
-legend {
-    color: #000;
-}
-input,button,textarea,select,optgroup,option {
-    font-family: inherit;
-    font-size: inherit;
-    font-style: inherit;
-    font-weight: inherit;
-}
-input,button,textarea,select {*font-size:100%;
-}
-/* END RESET */
-
-body {
-    margin-left: 1em;
-    margin-right: 1em;
-    font-family: arial, helvetica, geneva, sans-serif;
-    background-color: #ffffff; margin: 0px;
-}
-
-code, tt { font-family: monospace; font-size: 1.1em; }
-span.parameter { font-family:monospace; }
-span.parameter:after { content:":"; }
-span.types:before { content:"("; }
-span.types:after { content:")"; }
-.type { font-weight: bold; font-style:italic }
-
-body, p, td, th { font-size: .95em; line-height: 1.2em;}
-
-p, ul { margin: 10px 0 0 0px;}
-
-strong { font-weight: bold;}
-
-em { font-style: italic;}
-
-h1 {
-    font-size: 1.5em;
-    margin: 20px 0 20px 0;
-}
-h2, h3, h4 { margin: 15px 0 10px 0; }
-h2 { font-size: 1.25em; }
-h3 { font-size: 1.15em; }
-h4 { font-size: 1.06em; }
-
-a:link { font-weight: bold; color: #004080; text-decoration: none; }
-a:visited { font-weight: bold; color: #006699; text-decoration: none; }
-a:link:hover { text-decoration: underline; }
-
-hr {
-    color:#cccccc;
-    background: #00007f;
-    height: 1px;
-}
-
-blockquote { margin-left: 3em; }
-
-ul { list-style-type: disc; }
-
-p.name {
-    font-family: "Andale Mono", monospace;
-    padding-top: 1em;
-}
-
-pre {
-    background-color: rgb(245, 245, 245);
-    border: 1px solid #C0C0C0; /* silver */
-    padding: 10px;
-    margin: 10px 0 10px 0;
-    overflow: auto;
-    font-family: "Andale Mono", monospace;
-}
-
-pre.example {
-    font-size: .85em;
-}
-
-table.index { border: 1px #00007f; }
-table.index td { text-align: left; vertical-align: top; }
-
-#container {
-    margin-left: 1em;
-    margin-right: 1em;
-    background-color: #f0f0f0;
-}
-
-#product {
-    text-align: center;
-    border-bottom: 1px solid #cccccc;
-    background-color: #ffffff;
-}
-
-#product big {
-    font-size: 2em;
-}
-
-#main {
-    background-color: #f0f0f0;
-    border-left: 2px solid #cccccc;
-}
-
-#navigation {
-    float: left;
-    width: 14em;
-    vertical-align: top;
-    background-color: #f0f0f0;
-    overflow: visible;
-}
-
-#navigation h2 {
-    background-color:#e7e7e7;
-    font-size:1.1em;
-    color:#000000;
-    text-align: left;
-    padding:0.2em;
-    border-top:1px solid #dddddd;
-    border-bottom:1px solid #dddddd;
-}
-
-#navigation ul
-{
-    font-size:1em;
-    list-style-type: none;
-    margin: 1px 1px 10px 1px;
-}
-
-#navigation li {
-    text-indent: -1em;
-    display: block;
-    margin: 3px 0px 0px 22px;
-}
-
-#navigation li li a {
-    margin: 0px 3px 0px -1em;
-}
-
-#content {
-    margin-left: 14em;
-    padding: 1em;
-    width: 700px;
-    border-left: 2px solid #cccccc;
-    border-right: 2px solid #cccccc;
-    background-color: #ffffff;
-}
-
-#about {
-    clear: both;
-    padding: 5px;
-    border-top: 2px solid #cccccc;
-    background-color: #ffffff;
-}
-
-@media print {
-    body {
-        font: 12pt "Times New Roman", "TimeNR", Times, serif;
-    }
-    a { font-weight: bold; color: #004080; text-decoration: underline; }
-
-    #main {
-        background-color: #ffffff;
-        border-left: 0px;
-    }
-
-    #container {
-        margin-left: 2%;
-        margin-right: 2%;
-        background-color: #ffffff;
-    }
-
-    #content {
-        padding: 1em;
-        background-color: #ffffff;
-    }
-
-    #navigation {
-        display: none;
-    }
-    pre.example {
-        font-family: "Andale Mono", monospace;
-        font-size: 10pt;
-        page-break-inside: avoid;
-    }
-}
-
-table.module_list {
-    border-width: 1px;
-    border-style: solid;
-    border-color: #cccccc;
-    border-collapse: collapse;
-}
-table.module_list td {
-    border-width: 1px;
-    padding: 3px;
-    border-style: solid;
-    border-color: #cccccc;
-}
-table.module_list td.name { background-color: #f0f0f0; min-width: 200px; }
-table.module_list td.summary { width: 100%; }
-
-
-table.function_list {
-    border-width: 1px;
-    border-style: solid;
-    border-color: #cccccc;
-    border-collapse: collapse;
-}
-table.function_list td {
-    border-width: 1px;
-    padding: 3px;
-    border-style: solid;
-    border-color: #cccccc;
-}
-table.function_list td.name { background-color: #f0f0f0; min-width: 200px; }
-table.function_list td.summary { width: 100%; }
-
-ul.nowrap {
-    overflow:auto;
-    white-space:nowrap;
-}
-
-dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;}
-dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;}
-dl.table h3, dl.function h3 {font-size: .95em;}
-
-/* stop sublists from having initial vertical space */
-ul ul { margin-top: 0px; }
-ol ul { margin-top: 0px; }
-ol ol { margin-top: 0px; }
-ul ol { margin-top: 0px; }
-
-/* make the target distinct; helps when we're navigating to a function */
-a:target + * {
-  background-color: #FF9;
-}
-
-
-/* styles for prettification of source */
-pre .comment { color: #558817; }
-pre .constant { color: #a8660d; }
-pre .escape { color: #844631; }
-pre .keyword { color: #aa5050; font-weight: bold; }
-pre .library { color: #0e7c6b; }
-pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
-pre .string { color: #8080ff; }
-pre .number { color: #f8660d; }
-pre .operator { color: #2239a8; font-weight: bold; }
-pre .preprocessor, pre .prepro { color: #a33243; }
-pre .global { color: #800080; }
-pre .user-keyword { color: #800080; }
-pre .prompt { color: #558817; }
-pre .url { color: #272fc2; text-decoration: underline; }
-
diff --git a/doc/net/create_socket.md b/doc/net/create_socket.md
deleted file mode 100644
index e69de29..0000000
--- a/doc/net/create_socket.md
+++ /dev/null
diff --git a/doc/topics/readme.md.html b/doc/topics/readme.md.html
deleted file mode 100644
index f250100..0000000
--- a/doc/topics/readme.md.html
+++ /dev/null
@@ -1,81 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html>
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
-<head>
-    <title>Reference</title>
-    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
-</head>
-<body>
-
-<div id="container">
-
-<div id="product">
-	<div id="product_logo"></div>
-	<div id="product_name"><big><b></b></big></div>
-	<div id="product_description"></div>
-</div> <!-- id="product" -->
-
-
-<div id="main">
-
-
-<!-- Menu -->
-
-<div id="navigation">
-<br/>
-<h1>Brok[en]gine</h1>
-
-
-<h2>Contents</h2>
-<ul>
-<li><a href="#Download">Download </a></li>
-<li><a href="#Documentation">Documentation </a></li>
-<li><a href="#Misc">Misc </a></li>
-</ul>
-
-
-<h2>Topics</h2>
-<ul class="">
-  <li><strong>readme</strong></li>
-</ul>
-<h2>Modules</h2>
-<ul class="nowrap">
-  <li><a href="../index.html">net</a></li>
-</ul>
-
-</div>
-
-<div id="content">
-
-    # Brok[en]gine
-<p>![logo](https://cogarr.net/files/alex/brokenengine_small.png)
-<p>Broken Engine is a hobby game engine that glues [Bullet Physics](bulletphysics.org/wordpress), [Irrlicht](irrlicht.sourceforge.net), [Lua](www.lua.org), and [various](nanomsg.org) [other](www.boost.org) technologies togeather to give a realtime, 3d, physics engine.
-<p>## Download
-<p>Binaries will not be provided until Brok[en]gine reaches version 1.0, if you want to try it out before then, you will have to build the engine yourself.
-<p>1. Use [git](git-scm.com) to download this with submodules `git clone --recurse-submodules https://cogarr.net/source/cgi.cgit/brokengine`
-2. Download make, g++, ect. Windows users can use [mingw](https://mingw.org). Open a terminal and cd into this folder, and run `make`
-3. Binaries can be found in bin/(client|server)/bin/
-4. Initally ran scripts can be found at bin/(client|server)/data/init.lua
-<p>## Documentation
-Currently, documentation does not exist... I'll get around to it before 1.0
-<p>## Misc.
-This project is under very heavy development. Expect lots of code churn for the foreseeable future.
-<p>### Roadmap
-0. Lua-defined textures
-1. Lua-defined materials
-2. Lua-defined models
-3. Lua-defined hitboxes
-4. Networking utilities
-5. Make a tech demo game
-
-
-</div> <!-- id="content" -->
-</div> <!-- id="main" -->
-<div id="about">
-<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
-<i style="float:right;">Last updated 2018-07-03 16:38:22 </i>
-</div> <!-- id="about" -->
-</div> <!-- id="container" -->
-</body>
-</html>
author	Alexander Pickering <alex@cogarr.net>	2018-10-31 12:47:37 -0400
committer	Alexander Pickering <alex@cogarr.net>	2018-10-31 12:49:47 -0400
commit	8291075aeaf614c2f8dc0a0f4c199fd4a0d45cdd (patch)
tree	abc3c3a34eb832aea868bd5114d888a9e3c15dfa /doc
parent	9e9be703c8f1c58c76fd2051dd6fa6ce49a7a306 (diff)
download	brokengine-8291075aeaf614c2f8dc0a0f4c199fd4a0d45cdd.tar.gz brokengine-8291075aeaf614c2f8dc0a0f4c199fd4a0d45cdd.tar.bz2 brokengine-8291075aeaf614c2f8dc0a0f4c199fd4a0d45cdd.zip