mirror of
https://github.com/Keyslam-Group/Concord.git
synced 2025-12-07 13:44:55 -05:00
make the docs a little nicer
main changes: - add parameter and return types where applicable - use @module and @classmod tags at the top of files - remove some redundant descriptions of return values, especially for functions that return a boolean recommended next steps: - more consistent grammar - add links to classes and functions in descriptions where appropriate - be consistent about naming Systems vs. SystemClasses and Components vs. ComponentClasses
This commit is contained in:
Andrew Minnich
parent
55ae5fd987
commit
a65f88dd5e
31 changed files with 1474 additions and 1147 deletions
|
|
@ -38,38 +38,48 @@
|
|||
|
||||
<h2>Modules</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/assemblage.html">assemblage</a></li>
|
||||
<li><strong>assemblages</strong></li>
|
||||
<li><a href="../modules/component.html">component</a></li>
|
||||
<li><a href="../modules/components.html">components</a></li>
|
||||
<li><a href="../modules/entity.html">entity</a></li>
|
||||
<li><a href="../modules/init.html">init</a></li>
|
||||
<li><a href="../modules/list.html">list</a></li>
|
||||
<li><a href="../modules/pool.html">pool</a></li>
|
||||
<li><a href="../modules/system.html">system</a></li>
|
||||
<li><a href="../modules/systems.html">systems</a></li>
|
||||
<li><strong>Assemblages</strong></li>
|
||||
<li><a href="../modules/Components.html">Components</a></li>
|
||||
<li><a href="../modules/Concord.html">Concord</a></li>
|
||||
<li><a href="../modules/Systems.html">Systems</a></li>
|
||||
<li><a href="../modules/type.html">type</a></li>
|
||||
<li><a href="../modules/utils.html">utils</a></li>
|
||||
<li><a href="../modules/world.html">world</a></li>
|
||||
<li><a href="../modules/worlds.html">worlds</a></li>
|
||||
</ul>
|
||||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/Assemblage.html">Assemblage</a></li>
|
||||
<li><a href="../classes/Component.html">Component</a></li>
|
||||
<li><a href="../classes/Entity.html">Entity</a></li>
|
||||
<li><a href="../classes/List.html">List</a></li>
|
||||
<li><a href="../classes/Pool.html">Pool</a></li>
|
||||
<li><a href="../classes/System.html">System</a></li>
|
||||
<li><a href="../classes/World.html">World</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<h1>Module <code>assemblages</code></h1>
|
||||
<p>Assemblages
|
||||
Container for registered Assemblages</p>
|
||||
<h1>Module <code>Assemblages</code></h1>
|
||||
<p>A container for registered <a href="../classes/Assemblage.html#">Assemblage</a>s</p>
|
||||
<p></p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Assemblages.register">Assemblages.register (name, assemblage)</a></td>
|
||||
<td class="name" nowrap><a href="#register">register (name, assemblage)</a></td>
|
||||
<td class="summary">Registers an Assemblage.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#has">has (name)</a></td>
|
||||
<td class="summary">Returns true if the containter has an Assemblage with the specified name</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#get">get (name)</a></td>
|
||||
<td class="summary">Returns the Assemblage with the specified name</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
|
|
@ -80,8 +90,8 @@
|
|||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Assemblages.register"></a>
|
||||
<strong>Assemblages.register (name, assemblage)</strong>
|
||||
<a name = "register"></a>
|
||||
<strong>register (name, assemblage)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Registers an Assemblage.
|
||||
|
|
@ -90,9 +100,11 @@
|
|||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
Name to register under
|
||||
</li>
|
||||
<li><span class="parameter">assemblage</span>
|
||||
<span class="types"><a class="type" href="../classes/Assemblage.html#">Assemblage</a></span>
|
||||
Assemblage to register
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -101,6 +113,60 @@
|
|||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "has"></a>
|
||||
<strong>has (name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns true if the containter has an Assemblage with the specified name
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
Name of the Assemblage to check
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><span class="type">boolean</span></span>
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
<dt>
|
||||
<a name = "get"></a>
|
||||
<strong>get (name)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Returns the Assemblage with the specified name
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
Name of the Assemblage to get
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3>Returns:</h3>
|
||||
<ol>
|
||||
|
||||
<span class="types"><a class="type" href="../classes/Assemblage.html#">Assemblage</a></span>
|
||||
|
||||
</ol>
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
|
@ -109,7 +175,7 @@
|
|||
</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 2020-01-04 00:43:06 </i>
|
||||
<i style="float:right;">Last updated 2020-01-04 10:27:07 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue