mirror of
https://github.com/airstruck/luigi.git
synced 2025-12-19 02:16:43 +00:00
doc template
This commit is contained in:
airstruck
@@ -1,10 +1,9 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<!doctype html>
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css">
|
||||
</head>
|
||||
<body>
|
||||
|
||||
@@ -23,27 +22,14 @@
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>LUIGI</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Tables">Tables</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Classes</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><strong>Event</strong></li>
|
||||
<li><a href="../classes/Layout.html">Layout</a></li>
|
||||
<li><a href="../classes/Widget.html">Widget</a></li>
|
||||
</ul>
|
||||
<h2>Widgets</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<ul class="nowrap">
|
||||
<li><a href="../widgets/button.html">button</a></li>
|
||||
<li><a href="../widgets/check.html">check</a></li>
|
||||
<li><a href="../widgets/menu.html">menu</a></li>
|
||||
@@ -57,14 +43,21 @@
|
||||
<li><a href="../widgets/text.html">text</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/attribute.html">attribute</a></li>
|
||||
</ul>
|
||||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><strong>Event</strong></li>
|
||||
<li><a href="../classes/Layout.html">Layout</a></li>
|
||||
<li><a href="../classes/Widget.html">Widget</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<div id="content_top">
|
||||
<h1>Class <code>Event</code></h1>
|
||||
<p>Event class.</p>
|
||||
<p>
|
||||
@@ -80,9 +73,8 @@
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
</div>
|
||||
|
||||
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
|
||||
|
||||
@@ -165,7 +157,7 @@
|
||||
</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 2015-12-15 19:13:36 </i>
|
||||
<i style="float:right;">Last updated 2015-12-16 14:12:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
@@ -1,10 +1,9 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<!doctype html>
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css">
|
||||
</head>
|
||||
<body>
|
||||
|
||||
@@ -23,28 +22,14 @@
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>LUIGI</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
<li><a href="#Methods">Methods</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Classes</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../classes/Event.html">Event</a></li>
|
||||
<li><strong>Layout</strong></li>
|
||||
<li><a href="../classes/Widget.html">Widget</a></li>
|
||||
</ul>
|
||||
<h2>Widgets</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<ul class="nowrap">
|
||||
<li><a href="../widgets/button.html">button</a></li>
|
||||
<li><a href="../widgets/check.html">check</a></li>
|
||||
<li><a href="../widgets/menu.html">menu</a></li>
|
||||
@@ -58,14 +43,21 @@
|
||||
<li><a href="../widgets/text.html">text</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/attribute.html">attribute</a></li>
|
||||
</ul>
|
||||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/Event.html">Event</a></li>
|
||||
<li><strong>Layout</strong></li>
|
||||
<li><a href="../classes/Widget.html">Widget</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<div id="content_top">
|
||||
<h1>Class <code>Layout</code></h1>
|
||||
<p>A Layout contains a tree of widgets with a single <code>root</code> widget.</p>
|
||||
<p>Layouts will resize to fit the window unless a <code>top</code> or <code>left</code>
|
||||
@@ -130,9 +122,8 @@ and are trapped by the first layout that can handle the event
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
</div>
|
||||
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
Methods
|
||||
@@ -402,7 +393,7 @@ found, and focuses that widget.
|
||||
</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 2015-12-15 19:13:36 </i>
|
||||
<i style="float:right;">Last updated 2015-12-16 14:12:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
@@ -1,10 +1,9 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<!doctype html>
|
||||
<html>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Reference</title>
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../ldoc.css" type="text/css">
|
||||
</head>
|
||||
<body>
|
||||
|
||||
@@ -23,31 +22,14 @@
|
||||
<!-- Menu -->
|
||||
|
||||
<div id="navigation">
|
||||
<br/>
|
||||
<h1>LUIGI</h1>
|
||||
|
||||
<ul>
|
||||
<li><a href="../index.html">Index</a></li>
|
||||
</ul>
|
||||
|
||||
<h2>Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#Functions">Functions</a></li>
|
||||
<li><a href="#Methods">Methods</a></li>
|
||||
<li><a href="#API_Properties">API Properties </a></li>
|
||||
<li><a href="#Internal_Properties">Internal Properties </a></li>
|
||||
<li><a href="#Constructor">Constructor</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h2>Classes</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<li><a href="../classes/Event.html">Event</a></li>
|
||||
<li><a href="../classes/Layout.html">Layout</a></li>
|
||||
<li><strong>Widget</strong></li>
|
||||
</ul>
|
||||
<h2>Widgets</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<ul class="nowrap">
|
||||
<li><a href="../widgets/button.html">button</a></li>
|
||||
<li><a href="../widgets/check.html">check</a></li>
|
||||
<li><a href="../widgets/menu.html">menu</a></li>
|
||||
@@ -61,14 +43,21 @@
|
||||
<li><a href="../widgets/text.html">text</a></li>
|
||||
</ul>
|
||||
<h2>Modules</h2>
|
||||
<ul class="$(kind=='Topics' and '' or 'nowrap'">
|
||||
<ul class="nowrap">
|
||||
<li><a href="../modules/attribute.html">attribute</a></li>
|
||||
</ul>
|
||||
<h2>Classes</h2>
|
||||
<ul class="nowrap">
|
||||
<li><a href="../classes/Event.html">Event</a></li>
|
||||
<li><a href="../classes/Layout.html">Layout</a></li>
|
||||
<li><strong>Widget</strong></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
|
||||
<div id="content">
|
||||
|
||||
<div id="content_top">
|
||||
<h1>Class <code>Widget</code></h1>
|
||||
<p>Widget class.</p>
|
||||
<p>
|
||||
@@ -76,13 +65,6 @@
|
||||
</p>
|
||||
|
||||
|
||||
<h2><a href="#Functions">Functions</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Widget.register">Widget.register (name, decorator)</a></td>
|
||||
<td class="summary">Register a custom widget type.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Methods">Methods</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
@@ -196,6 +178,13 @@
|
||||
<td class="summary">The <code>Text</code> object associated with the widget.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Static_Functions">Static Functions </a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap><a href="#Widget.register">Widget.register (name, decorator)</a></td>
|
||||
<td class="summary">Register a custom widget type.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a href="#Constructor">Constructor</a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
@@ -204,39 +193,9 @@
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
</div>
|
||||
|
||||
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
|
||||
Methods
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Widget.register"></a>
|
||||
<strong>Widget.register (name, decorator)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register a custom widget type.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
A unique name for this type of widget.
|
||||
</li>
|
||||
<li><span class="parameter">decorator</span>
|
||||
<span class="types"><span class="type">function(Widget)</span></span>
|
||||
An initialization function for this type of widget.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Methods"></a>Methods</h2>
|
||||
|
||||
<dl class="function">
|
||||
@@ -837,6 +796,35 @@ initializers should run on the widget.
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Static_Functions"></a>Static Functions </h2>
|
||||
|
||||
<dl class="function">
|
||||
<dt>
|
||||
<a name = "Widget.register"></a>
|
||||
<strong>Widget.register (name, decorator)</strong>
|
||||
</dt>
|
||||
<dd>
|
||||
Register a custom widget type.
|
||||
|
||||
|
||||
<h3>Parameters:</h3>
|
||||
<ul>
|
||||
<li><span class="parameter">name</span>
|
||||
<span class="types"><a class="type" href="http://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
|
||||
A unique name for this type of widget.
|
||||
</li>
|
||||
<li><span class="parameter">decorator</span>
|
||||
<span class="types"><span class="type">function(Widget)</span></span>
|
||||
An initialization function for this type of widget.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<h2 class="section-header "><a name="Constructor"></a>Constructor</h2>
|
||||
@@ -882,7 +870,7 @@ This table is identical to the constructed widget.
|
||||
</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 2015-12-15 19:13:36 </i>
|
||||
<i style="float:right;">Last updated 2015-12-16 14:12:04 </i>
|
||||
</div> <!-- id="about" -->
|
||||
</div> <!-- id="container" -->
|
||||
</body>
|
||||
|
||||
Reference in New Issue
Block a user