Fix documentation

Syntax error caused "Wizard:add_page()" function to not be documented on the generated HTML.
PedroAlvesV · Mar 21, 2017 · 1639aab · 1639aab
1 parent 08b6fd2
commit 1639aab
Show file tree

Hide file tree

Showing 7 changed files with 116 additions and 69 deletions.
diff --git a/docs/classes/AbsCurses.html b/docs/classes/AbsCurses.html
@@ -55,10 +55,6 @@ <h1>Class <code>AbsCurses</code></h1>
 <p>
 
 </p>
-    <h3>See also:</h3>
-    <ul>
-         <a href="../modules/abstk.html#">abstk</a>
-    </ul>
     <h3>Info:</h3>
     <ul>
         <li><strong>License</strong>: MIT</li>
@@ -76,8 +72,8 @@ <h3>Info:</h3>
 </div> <!-- id="content" -->
 </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 2017-03-20 14:30:16 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
+<i style="float:right;">Last updated 2017-03-21 18:52:46 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/classes/AbsGtk.html b/docs/classes/AbsGtk.html
@@ -55,10 +55,6 @@ <h1>Class <code>AbsGtk</code></h1>
 <p>
 
 </p>
-    <h3>See also:</h3>
-    <ul>
-         <a href="../modules/abstk.html#">abstk</a>
-    </ul>
     <h3>Info:</h3>
     <ul>
         <li><strong>License</strong>: MIT</li>
@@ -76,8 +72,8 @@ <h3>Info:</h3>
 </div> <!-- id="content" -->
 </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 2017-03-20 14:30:16 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
+<i style="float:right;">Last updated 2017-03-21 18:52:46 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/index.html b/docs/index.html
@@ -79,8 +79,8 @@ <h2>Topics</h2>
 </div> <!-- id="content" -->
 </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 2017-03-20 14:30:16 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
+<i style="float:right;">Last updated 2017-03-21 18:52:46 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/ldoc.css b/docs/ldoc.css
@@ -28,6 +28,7 @@ del,ins {
     text-decoration: none;
 }
 li {
+    list-style: disc;
     margin-left: 20px;
 }
 caption,th {
@@ -87,7 +88,7 @@ em { font-style: italic;}
 
 h1 {
     font-size: 1.5em;
-    margin: 20px 0 20px 0;
+    margin: 0 0 20px 0;
 }
 h2, h3, h4 { margin: 15px 0 10px 0; }
 h2 { font-size: 1.25em; }
@@ -113,18 +114,24 @@ p.name {
     padding-top: 1em;
 }
 
+pre.example {
+    background-color: rgb(245, 245, 245);
+    border: 1px solid silver;
+    padding: 10px;
+    margin: 10px 0 10px 0;
+    font-family: "Andale Mono", monospace;
+    font-size: .85em;
+}
+
 pre {
     background-color: rgb(245, 245, 245);
-    border: 1px solid #C0C0C0; /* silver */
+    border: 1px solid silver;
     padding: 10px;
     margin: 10px 0 10px 0;
     overflow: auto;
     font-family: "Andale Mono", monospace;
 }
 
-pre.example {
-    font-size: .85em;
-}
 
 table.index { border: 1px #00007f; }
 table.index td { text-align: left; vertical-align: top; }
@@ -284,7 +291,6 @@ a:target + * {
   background-color: #FF9;
 }
 
-
 /* styles for prettification of source */
 pre .comment { color: #558817; }
 pre .constant { color: #a8660d; }
@@ -297,7 +303,5 @@ pre .number { color: #f8660d; }
 pre .operator { color: #2239a8; font-weight: bold; }
 pre .preprocessor, pre .prepro { color: #a33243; }
 pre .global { color: #800080; }
-pre .user-keyword { color: #800080; }
 pre .prompt { color: #558817; }
 pre .url { color: #272fc2; text-decoration: underline; }
-
diff --git a/docs/modules/abstk.html b/docs/modules/abstk.html
@@ -81,7 +81,7 @@ <h2><a href="#abstk">abstk</a></h2>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#new_wizard">new_wizard (title, w, h)</a></td>
-	<td class="summary">Constructs a wizard.</td>
+	<td class="summary">Constructs a Wizard.</td>
 	</tr>
 </table>
 <h2><a href="#Class_Screen">Class Screen </a></h2>
@@ -160,6 +160,10 @@ <h2><a href="#Class_Screen">Class Screen </a></h2>
 </table>
 <h2><a href="#Class_Wizard">Class Wizard </a></h2>
 <table class="function_list">
+	<tr>
+	<td class="name" nowrap><a href="#Wizard:add_page">Wizard:add_page (id, screen)</a></td>
+	<td class="summary">Adds a screen to a wizard.</td>
+	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#Wizard:run">Wizard:run (self)</a></td>
 	<td class="summary">Runs a wizard.</td>
@@ -170,7 +174,7 @@ <h2><a href="#Class_Wizard">Class Wizard </a></h2>
 <br/>
 
 
-    <h2 class="section-header "><a name="abstk"></a>abstk</h2>
+    <h2><a name="abstk"></a>abstk</h2>
 
     <dl class="function">
     <dt>
@@ -230,7 +234,7 @@ <h3>Returns:</h3>
     <strong>new_wizard (title, w, h)</strong>
     </dt>
     <dd>
-    Constructs a wizard.
+    Constructs a Wizard.
 
 
     <h3>Parameters:</h3>
@@ -257,7 +261,8 @@ <h3>Returns:</h3>
 
 </dd>
 </dl>
-    <h2 class="section-header "><a name="Class_Screen"></a>Class Screen </h2>
+    <h2><a name="Class_Screen"></a>Class Screen </h2>
+
 
     <dl class="function">
     <dt>
@@ -426,8 +431,8 @@ <h3>Parameters:</h3>
 
     <h3>Usage:</h3>
     <ul>
-        <pre class="example">scr:add_image(<span class="string">'lua_img'</span>, <span class="string">'images/lua.png'</span>)
-scr:add_image(<span class="string">'batman_img'</span>, <span class="string">'images/batman.png'</span>, {<span class="number">512</span>, <span class="number">384</span>})</pre>
+        <pre class="example"> scr:add_image(<span class="string">'lua_img'</span>, <span class="string">'images/lua.png'</span>)
+ scr:add_image(<span class="string">'batman_img'</span>, <span class="string">'images/batman.png'</span>, {<span class="number">512</span>, <span class="number">384</span>})</pre>
     </ul>
 
 </dd>
@@ -645,17 +650,17 @@ <h3>See also:</h3>
 
     <h3>Usage:</h3>
     <ul>
-        <pre class="example">scr:create_checklist(<span class="string">'style1'</span>, <span class="string">"Checklist 1:"</span>, {<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>}, <span class="keyword">nil</span>, tooltip, chk_callback)
+        <pre class="example"> scr:create_checklist(<span class="string">'style1'</span>, <span class="string">"Checklist 1:"</span>, {<span class="string">'a'</span>, <span class="string">'b'</span>, <span class="string">'c'</span>}, <span class="keyword">nil</span>, tooltip, chk_callback)
 
-scr:create_checklist(<span class="string">'style2'</span>, <span class="string">"Checklist 2:"</span>, {<span class="string">'7'</span>, <span class="string">'8'</span>, <span class="string">'9'</span>}, {<span class="keyword">true</span>, <span class="keyword">false</span>, <span class="keyword">true</span>}, tooltip, chk_callback)
+ scr:create_checklist(<span class="string">'style2'</span>, <span class="string">"Checklist 2:"</span>, {<span class="string">'7'</span>, <span class="string">'8'</span>, <span class="string">'9'</span>}, {<span class="keyword">true</span>, <span class="keyword">false</span>, <span class="keyword">true</span>}, tooltip, chk_callback)
 
-<span class="keyword">local</span> check_table = {
-  {<span class="string">'z'</span>, <span class="keyword">false</span>},
-  {<span class="string">'x'</span>, <span class="keyword">true</span>},
-  {<span class="string">'c'</span>, <span class="keyword">true</span>},
-}
-scr:create_checklist(<span class="string">'style3'</span>, <span class="string">"Checklist 3:"</span>, check_table, <span class="keyword">nil</span>, tooltip, chk_callback)
-scr:create_checklist(<span class="string">'style4'</span>, <span class="string">"Checklist 4:"</span>, {<span class="string">'x'</span>, <span class="string">'y'</span>, <span class="string">'z'</span>}, <span class="number">3</span>, tooltip, chk_callback)</pre>
+ <span class="keyword">local</span> check_table = {
+   {<span class="string">'z'</span>, <span class="keyword">false</span>},
+   {<span class="string">'x'</span>, <span class="keyword">true</span>},
+   {<span class="string">'c'</span>, <span class="keyword">true</span>},
+ }
+ scr:create_checklist(<span class="string">'style3'</span>, <span class="string">"Checklist 3:"</span>, check_table, <span class="keyword">nil</span>, tooltip, chk_callback)
+ scr:create_checklist(<span class="string">'style4'</span>, <span class="string">"Checklist 4:"</span>, {<span class="string">'x'</span>, <span class="string">'y'</span>, <span class="string">'z'</span>}, <span class="number">3</span>, tooltip, chk_callback)</pre>
     </ul>
 
 </dd>
@@ -718,16 +723,16 @@ <h3>See also:</h3>
 
     <h3>Usage:</h3>
     <ul>
-        <pre class="example">scr:create_selector(<span class="string">'style1'</span>, <span class="string">"Selector 1:"</span>, {<span class="string">'x'</span>, <span class="string">'y'</span>, <span class="string">'z'</span>}, <span class="keyword">nil</span>, tooltip, slct_callback)
+        <pre class="example"> scr:create_selector(<span class="string">'style1'</span>, <span class="string">"Selector 1:"</span>, {<span class="string">'x'</span>, <span class="string">'y'</span>, <span class="string">'z'</span>}, <span class="keyword">nil</span>, tooltip, slct_callback)
 
-scr:create_selector(<span class="string">'style2'</span>, <span class="string">"Selector 2:"</span>, {<span class="string">'a'</span>, <span class="string">'s'</span>, <span class="string">'d'</span>}, <span class="number">3</span>, tooltip, slct_callback)
+ scr:create_selector(<span class="string">'style2'</span>, <span class="string">"Selector 2:"</span>, {<span class="string">'a'</span>, <span class="string">'s'</span>, <span class="string">'d'</span>}, <span class="number">3</span>, tooltip, slct_callback)
 
-<span class="keyword">local</span> selector_values = {
-  {<span class="string">'q'</span>, <span class="keyword">false</span>},
-  {<span class="string">'w'</span>, <span class="keyword">true</span>},
-  {<span class="string">'e'</span>, <span class="keyword">false</span>},
-}
-scr:create_selector(<span class="string">'style3'</span>, <span class="string">"Selector 3:"</span>, selector_values, <span class="keyword">nil</span>, tooltip, slct_callback)</pre>
+ <span class="keyword">local</span> selector_values = {
+   {<span class="string">'q'</span>, <span class="keyword">false</span>},
+   {<span class="string">'w'</span>, <span class="keyword">true</span>},
+   {<span class="string">'e'</span>, <span class="keyword">false</span>},
+ }
+ scr:create_selector(<span class="string">'style3'</span>, <span class="string">"Selector 3:"</span>, selector_values, <span class="keyword">nil</span>, tooltip, slct_callback)</pre>
     </ul>
 
 </dd>
@@ -863,17 +868,17 @@ <h3>Parameters:</h3>
 
     <h3>Usage:</h3>
     <ul>
-        <pre class="example">scr:set_value(<span class="string">'label'</span>, <span class="string">"New Label"</span>)
-scr:set_value(<span class="string">'button'</span>, <span class="string">"New Button Label"</span>)
-scr:set_value(<span class="string">'button_box'</span>, <span class="string">"New Button Label"</span>, <span class="number">2</span>)
-scr:set_value(<span class="string">'combobox'</span>, <span class="number">2</span>)
-scr:set_value(<span class="string">'image'</span>, <span class="string">'imgs/image.png'</span>)
-scr:set_value(<span class="string">'text_input'</span>, <span class="string">"New Text"</span>)
-scr:set_value(<span class="string">'password_input'</span>, <span class="string">"New Password"</span>)
-scr:set_value(<span class="string">'textbox'</span>, <span class="string">"New Text"</span>)
-scr:set_value(<span class="string">'checkbox'</span>, <span class="keyword">true</span>)
-scr:set_value(<span class="string">'checklist'</span>, <span class="keyword">true</span>, <span class="number">1</span>)
-scr:set_value(<span class="string">'selector'</span>, <span class="number">2</span>)</pre>
+        <pre class="example"> scr:set_value(<span class="string">'label'</span>, <span class="string">"New Label"</span>)
+ scr:set_value(<span class="string">'button'</span>, <span class="string">"New Button Label"</span>)
+ scr:set_value(<span class="string">'button_box'</span>, <span class="string">"New Button Label"</span>, <span class="number">2</span>)
+ scr:set_value(<span class="string">'combobox'</span>, <span class="number">2</span>)
+ scr:set_value(<span class="string">'image'</span>, <span class="string">'imgs/image.png'</span>)
+ scr:set_value(<span class="string">'text_input'</span>, <span class="string">"New Text"</span>)
+ scr:set_value(<span class="string">'password_input'</span>, <span class="string">"New Password"</span>)
+ scr:set_value(<span class="string">'textbox'</span>, <span class="string">"New Text"</span>)
+ scr:set_value(<span class="string">'checkbox'</span>, <span class="keyword">true</span>)
+ scr:set_value(<span class="string">'checklist'</span>, <span class="keyword">true</span>, <span class="number">1</span>)
+ scr:set_value(<span class="string">'selector'</span>, <span class="number">2</span>)</pre>
     </ul>
 
 </dd>
@@ -948,14 +953,40 @@ <h3>Returns:</h3>
 
     <h3>See also:</h3>
     <ul>
+         <a href="../modules/abstk.html#Wizard:add_page">Wizard:add_page</a>
     </ul>
 
 
 </dd>
 </dl>
-    <h2 class="section-header "><a name="Class_Wizard"></a>Class Wizard </h2>
+    <h2><a name="Class_Wizard"></a>Class Wizard </h2>
+
 
     <dl class="function">
+    <dt>
+    <a name = "Wizard:add_page"></a>
+    <strong>Wizard:add_page (id, screen)</strong>
+    </dt>
+    <dd>
+    Adds a screen to a wizard.  The screen turns into a page with footer navigation
+ buttons.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">id</span>
+         the id of the object
+        </li>
+        <li><span class="parameter">screen</span>
+         the screen that will be added
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
     <dt>
     <a name = "Wizard:run"></a>
     <strong>Wizard:run (self)</strong>
@@ -982,6 +1013,7 @@ <h3>Returns:</h3>
 
     <h3>See also:</h3>
     <ul>
+         <a href="../modules/abstk.html#Wizard:add_page">Wizard:add_page</a>
     </ul>
 
 
@@ -992,8 +1024,8 @@ <h3>See also:</h3>
 </div> <!-- id="content" -->
 </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 2017-03-20 14:30:16 </i>
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
+<i style="float:right;">Last updated 2017-03-21 18:52:46 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>