Skip to content

Commit

Permalink
Docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Tourahi committed Jan 14, 2024
1 parent 052e5d7 commit d858a8f
Show file tree
Hide file tree
Showing 25 changed files with 944 additions and 234 deletions.
4 changes: 2 additions & 2 deletions docs/classes/Box.html
Original file line number Diff line number Diff line change
Expand Up @@ -408,8 +408,8 @@ <h3>Parameters:</h3>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-05-17 08:19:20 </i>
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2024-01-14 01:18:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/Chrono.html
Original file line number Diff line number Diff line change
Expand Up @@ -240,8 +240,8 @@ <h3>Parameters:</h3>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-05-17 08:19:20 </i>
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2024-01-14 01:18:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/Circle.html
Original file line number Diff line number Diff line change
Expand Up @@ -422,8 +422,8 @@ <h3>Parameters:</h3>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-05-17 08:19:20 </i>
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2024-01-14 01:18:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/Collection.html
Original file line number Diff line number Diff line change
Expand Up @@ -259,8 +259,8 @@ <h3>Parameters:</h3>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-05-17 08:19:20 </i>
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2024-01-14 01:18:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
110 changes: 94 additions & 16 deletions docs/classes/Control.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,10 @@ <h2><a href="#Methods">Methods</a></h2>
<td class="summary">constructor.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#control\getId">control\getId ()</a></td>
<td class="summary">gets control id</td>
</tr>
<tr>
<td class="name" nowrap><a href="#control\getRoot">control\getRoot ()</a></td>
<td class="summary">getter for the root control.</td>
</tr>
Expand Down Expand Up @@ -278,12 +282,20 @@ <h2><a href="#Methods">Methods</a></h2>
<td class="summary">sets updateWhenFocused (if true the UI_UPDATE event will be triggred when the control is clicked.).</td>
</tr>
<tr>
<td class="name" nowrap><a href="#control\setFocuse">control\setFocuse (bool)</a></td>
<td class="summary">sets focused property</td>
<td class="name" nowrap><a href="#control\setLabel">control\setLabel (l)</a></td>
<td class="summary">sets control label (Mainly for debug)</td>
</tr>
<tr>
<td class="name" nowrap><a href="#control\isFocused">control\isFocused ()</a></td>
<td class="summary">return focused property</td>
<td class="name" nowrap><a href="#control\getLabel">control\getLabel ()</a></td>
<td class="summary">gets control label (Mainly for debug)</td>
</tr>
<tr>
<td class="name" nowrap><a href="#control\setNotifyParent">control\setNotifyParent (bool)</a></td>
<td class="summary">sets notifyParent</td>
</tr>
<tr>
<td class="name" nowrap><a href="#control\getNotifyParent">control\getNotifyParent (bool)</a></td>
<td class="summary">gets notifyParent</td>
</tr>
</table>

Expand Down Expand Up @@ -396,6 +408,26 @@ <h3>Parameters:</h3>



</dd>
<dt>
<a name = "control\getId"></a>
<strong>control\getId ()</strong>
</dt>
<dd>
gets control id



<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>
id
</ol>




</dd>
<dt>
<a name = "control\getRoot"></a>
Expand Down Expand Up @@ -1326,17 +1358,17 @@ <h3>Parameters:</h3>

</dd>
<dt>
<a name = "control\setFocuse"></a>
<strong>control\setFocuse (bool)</strong>
<a name = "control\setLabel"></a>
<strong>control\setLabel (l)</strong>
</dt>
<dd>
sets focused property
sets control label (Mainly for debug)


<h3>Parameters:</h3>
<ul>
<li><span class="parameter">bool</span>
<span class="types"><span class="type">bool</span></span>
<li><span class="parameter">l</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>



Expand All @@ -1349,33 +1381,79 @@ <h3>Parameters:</h3>

</dd>
<dt>
<a name = "control\isFocused"></a>
<strong>control\isFocused ()</strong>
<a name = "control\getLabel"></a>
<strong>control\getLabel ()</strong>
</dt>
<dd>
return focused property
gets control label (Mainly for debug)



<h3>Returns:</h3>
<ol>

<span class="types"><span class="type">boolean</span></span>
focused
<span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span>
l
</ol>




</dd>
<dt>
<a name = "control\setNotifyParent"></a>
<strong>control\setNotifyParent (bool)</strong>
</dt>
<dd>
sets notifyParent


<h3>Parameters:</h3>
<ul>
<li><span class="parameter">bool</span>
<span class="types"><span class="type">bool</span></span>



</li>
</ul>





</dd>
<dt>
<a name = "control\getNotifyParent"></a>
<strong>control\getNotifyParent (bool)</strong>
</dt>
<dd>
gets notifyParent


<h3>Parameters:</h3>
<ul>
<li><span class="parameter">bool</span>
<span class="types"><span class="type">bool</span></span>



</li>
</ul>





</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-05-17 08:19:20 </i>
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2024-01-14 01:18:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/Debug.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ <h2 class="section-header "><a name="Methods"></a>Methods</h2>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-05-17 08:19:20 </i>
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2024-01-14 01:18:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/Event.html
Original file line number Diff line number Diff line change
Expand Up @@ -427,8 +427,8 @@ <h3>Parameters:</h3>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-05-17 08:19:20 </i>
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2024-01-14 01:18:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
10 changes: 5 additions & 5 deletions docs/classes/Manager.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ <h2><a href="#Methods">Methods</a></h2>
<td class="summary">callback function triggered when the mouse is moved.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#manager\setFocuse">manager\setFocuse (control)</a></td>
<td class="name" nowrap><a href="#manager\setFocus">manager\setFocus (control)</a></td>
<td class="summary">focuse on given control.</td>
</tr>
<tr>
Expand Down Expand Up @@ -253,8 +253,8 @@ <h3>Parameters:</h3>

</dd>
<dt>
<a name = "manager\setFocuse"></a>
<strong>manager\setFocuse (control)</strong>
<a name = "manager\setFocus"></a>
<strong>manager\setFocus (control)</strong>
</dt>
<dd>
focuse on given control.
Expand Down Expand Up @@ -502,8 +502,8 @@ <h3>Parameters:</h3>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-05-17 08:19:20 </i>
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2024-01-14 01:18:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/Polygon.html
Original file line number Diff line number Diff line change
Expand Up @@ -461,8 +461,8 @@ <h3>Returns:</h3>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-05-17 08:19:20 </i>
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2024-01-14 01:18:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/Root.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,8 @@ <h2 class="section-header "><a name="Methods"></a>Methods</h2>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-05-17 08:19:20 </i>
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2024-01-14 01:18:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/Singleton.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,8 @@ <h3>Parameters:</h3>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/lunarmodules/ldoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2023-05-17 08:19:20 </i>
<i>generated by <a href="http://github.com/lunarmodules/LDoc">LDoc 1.5.0</a></i>
<i style="float:right;">Last updated 2024-01-14 01:18:20 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
Loading

0 comments on commit d858a8f

Please sign in to comment.