Skip to content

Commit

Permalink
updated/fixed documentation
Browse files Browse the repository at this point in the history
added module description on top, with the side effect that totable() is not longer missing in the docs
  • Loading branch information
imolein committed Jul 1, 2019
1 parent 73d1a7c commit 94de6ad
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 3 deletions.
45 changes: 42 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,23 @@ <h2>Modules</h2>
<div id="content">

<h1>Module <code>lua_fun</code></h1>
<p>evaluates a one or two values generator into a table
creates an array for a single value generator and a regular table otherwise</p>
<p>Functional programming library for lua lang.</p>
<p></p>
<h3>Info:</h3>
<ul>
<li><strong>Copyright</strong>: IMAIA, 2019</li>
<li><strong>License</strong>: MIT</li>
<li><strong>Author</strong>: Italo Maia</li>
</ul>


<h2><a href="#Local_Functions">Local Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#totable">totable (gen)</a></td>
<td class="summary">evaluates a one or two values generator into a table
creates an array for a single value generator and a regular table otherwise</td>
</tr>
<tr>
<td class="name" nowrap><a href="#generator">generator (t)</a></td>
<td class="summary">creates a generator function for the items of `t`</td>
Expand Down Expand Up @@ -134,6 +144,35 @@ <h2><a href="#Local_Functions">Local Functions</a></h2>
<h2 class="section-header "><a name="Local_Functions"></a>Local Functions</h2>

<dl class="function">
<dt>
<a name = "totable"></a>
<strong>totable (gen)</strong>
</dt>
<dd>
evaluates a one or two values generator into a table
creates an array for a single value generator and a regular table otherwise


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

</li>
</ul>

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

table
</ol>

<h3>Raises:</h3>
if `gen` is not a function



</dd>
<dt>
<a name = "generator"></a>
<strong>generator (t)</strong>
Expand Down Expand Up @@ -675,7 +714,7 @@ <h3>Returns:</h3>
</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 2019-05-11 02:58:07 </i>
<i style="float:right;">Last updated 2019-07-01 10:26:42 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
8 changes: 8 additions & 0 deletions src/lua_fun.lua
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---Functional programming library for lua lang.
-- @module lua_fun
-- @author Italo Maia
-- @license MIT
-- @copyright IMAIA, 2019

-- @section functions

--- evaluates a one or two values generator into a table
-- creates an array for a single value generator and a regular table otherwise
--
Expand Down

0 comments on commit 94de6ad

Please sign in to comment.