Pop.Box/docs/modules/util.html

120 lines
2.4 KiB
HTML
Raw Normal View History

2016-06-21 05:52:44 +00:00
<!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>Documentation</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>Pop.Box()</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Functions">Functions</a></li>
</ul>
<h2>Modules</h2>
<ul class="$(kind=='Topics' and '' or 'nowrap'">
<li><a href="../modules/pop.html">pop</a></li>
<li><strong>util</strong></li>
</ul>
</div>
<div id="content">
<h1>Module <code>util</code></h1>
<p>Utility functions, intended for internal use only.</p>
<p>
</p>
<h3>Info:</h3>
<ul>
<li><strong>Copyright</strong>: Paul Liverman III (2015-2016)</li>
<li><strong>Release</strong>: v0.0.0</li>
<li><strong>License</strong>: The MIT License (MIT)</li>
</ul>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#inheritsFromElement">inheritsFromElement (object)</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 = "inheritsFromElement"></a>
<strong>inheritsFromElement (object)</strong>
</dt>
<dd>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">object</span>
A table (MoonScript object expected) to be checked for inheritence from the "element" element.
</li>
</ul>
<h3>Returns:</h3>
<ol>
<code>true</code> / <code>false</code>: Is the table an object inherting from "element"?
</ol>
<h3>Raises:</h3>
Can error if the table has a similar structure to a MoonScript object without being the same structure.
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2016-06-20 22:28:27 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>