updated documentation

xHasKx · Jun 24, 2020 · dbcb111 · dbcb111
1 parent 8659c8c
commit dbcb111
Show file tree

Hide file tree

Showing 8 changed files with 31 additions and 23 deletions.
diff --git a/docs/examples/mqtt5-simple.lua.html b/docs/examples/mqtt5-simple.lua.html
@@ -60,9 +60,12 @@ <h2>mqtt5-simple.lua</h2>
 
 <span class="comment">-- create mqtt client
 </span><span class="keyword">local</span> client = mqtt.client{
-	uri = <span class="string">"mqtt.flespi.io"</span>,
+	<span class="comment">-- uri = "mqtt.flespi.io",
+</span>	uri = <span class="string">"localhost:11004"</span>,
+	secure = <span class="keyword">true</span>,
 	<span class="comment">-- NOTE: more about flespi tokens: https://flespi.com/kb/tokens-access-keys-to-flespi-platform
-</span>	username = <span class="string">"stPwSVV73Eqw5LSv0iMXbc4EguS7JyuZR9lxU5uLxI5tiNM8ToTVqNpu85pFtJv9"</span>,
+</span>	<span class="comment">-- username = "stPwSVV73Eqw5LSv0iMXbc4EguS7JyuZR9lxU5uLxI5tiNM8ToTVqNpu85pFtJv9",
+</span>	username = <span class="string">"1duEjcovftbJprajuFhmpaovOicD01tP4OhdOwyRPyo3Ppc7Sij7ivrXErosjH6b"</span>,
 	clean = <span class="keyword">true</span>,
 	version = mqtt.v50,
 }
@@ -120,7 +123,7 @@ <h2>mqtt5-simple.lua</h2>
 </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 2020-03-05 09:31:57 </i>
+<i style="float:right;">Last updated 2020-06-24 21:04:55 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/examples/simple.lua.html b/docs/examples/simple.lua.html
@@ -115,7 +115,7 @@ <h2>simple.lua</h2>
 </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 2020-03-05 09:31:57 </i>
+<i style="float:right;">Last updated 2020-06-24 21:04:55 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/examples/sync.lua.html b/docs/examples/sync.lua.html
@@ -121,7 +121,7 @@ <h2>sync.lua</h2>
 </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 2020-03-05 09:31:57 </i>
+<i style="float:right;">Last updated 2020-06-24 21:04:55 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/index.html b/docs/index.html
@@ -101,7 +101,7 @@ <h2>Examples</h2>
 </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 2020-03-05 09:31:57 </i>
+<i style="float:right;">Last updated 2020-06-24 21:04:55 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/mqtt.client.html b/docs/modules/mqtt.client.html
@@ -699,7 +699,7 @@ <h3>See also:</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 2020-03-05 09:31:57 </i>
+<i style="float:right;">Last updated 2020-06-24 21:04:55 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/mqtt.html b/docs/modules/mqtt.html
@@ -76,7 +76,7 @@ <h2><a href="#Functions">Functions</a></h2>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#run_ioloop">run_ioloop (...)</a></td>
-	<td class="summary">Run default ioloop for given MQTT clients</td>
+	<td class="summary">Run default ioloop for given MQTT clients or functions</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#run_sync">run_sync (cl)</a></td>
@@ -141,13 +141,13 @@ <h3>See also:</h3>
     <strong>run_ioloop (...)</strong>
     </dt>
     <dd>
-    Run default ioloop for given MQTT clients
+    Run default ioloop for given MQTT clients or functions
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">...</span>
-         MQTT clients to add to ioloop
+         MQTT clients or lopp functions to add to ioloop
         </li>
     </ul>
 
@@ -220,7 +220,7 @@ <h3>Fields:</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 2020-03-05 09:31:57 </i>
+<i style="float:right;">Last updated 2020-06-24 21:04:55 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/mqtt.ioloop.html b/docs/modules/mqtt.ioloop.html
@@ -71,11 +71,11 @@ <h2><a href="#Class_ioloop_mt">Class ioloop_mt </a></h2>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#ioloop_mt:add">ioloop_mt:add (client)</a></td>
-	<td class="summary">Add MQTT client to the ioloop instance</td>
+	<td class="summary">Add MQTT client or a loop function to the ioloop instance</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#ioloop_mt:remove">ioloop_mt:remove (client)</a></td>
-	<td class="summary">Remove MQTT client from the ioloop instance</td>
+	<td class="summary">Remove MQTT client or a loop function from the ioloop instance</td>
 	</tr>
 	<tr>
 	<td class="name" nowrap><a href="#ioloop_mt:iteration">ioloop_mt:iteration ()</a></td>
@@ -90,7 +90,7 @@ <h2><a href="#Class_ioloop_mt">Class ioloop_mt </a></h2>
 	<td class="summary">Run ioloop until at least one client are in ioloop</td>
 	</tr>
 	<tr>
-	<td class="name" nowrap><a href="#ioloop_mt:get">ioloop_mt:get ([autocreate=true])</a></td>
+	<td class="name" nowrap><a href="#ioloop_mt:get">ioloop_mt:get ([autocreate=true[, args]])</a></td>
 	<td class="summary">Returns default ioloop instance</td>
 	</tr>
 </table>
@@ -151,14 +151,14 @@ <h3>Returns:</h3>
     <strong>ioloop_mt:add (client)</strong>
     </dt>
     <dd>
-    Add MQTT client to the ioloop instance
+    Add MQTT client or a loop function to the ioloop instance
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">client</span>
-            <span class="types"><a class="type" href="../modules/mqtt.html#client">client_mt</a></span>
-        		MQTT client to add to ioloop
+            <span class="types"><a class="type" href="../modules/mqtt.html#client">client_mt</a> or <span class="type">function</span></span>
+        		MQTT client or a loop function to add to ioloop
         </li>
     </ul>
 
@@ -177,14 +177,14 @@ <h3>Returns:</h3>
     <strong>ioloop_mt:remove (client)</strong>
     </dt>
     <dd>
-    Remove MQTT client from the ioloop instance
+    Remove MQTT client or a loop function from the ioloop instance
 
 
     <h3>Parameters:</h3>
     <ul>
         <li><span class="parameter">client</span>
-            <span class="types"><a class="type" href="../modules/mqtt.html#client">client_mt</a></span>
-        		MQTT client to remove from ioloop
+            <span class="types"><a class="type" href="../modules/mqtt.html#client">client_mt</a> or <span class="type">function</span></span>
+        		MQTT client or a loop function to remove from ioloop
         </li>
     </ul>
 
@@ -242,7 +242,7 @@ <h3>Returns:</h3>
 </dd>
     <dt>
     <a name = "ioloop_mt:get"></a>
-    <strong>ioloop_mt:get ([autocreate=true])</strong>
+    <strong>ioloop_mt:get ([autocreate=true[, args]])</strong>
     </dt>
     <dd>
     Returns default ioloop instance
@@ -255,6 +255,11 @@ <h3>Parameters:</h3>
          Automatically create ioloop instance
          (<em>default</em> true)
         </li>
+        <li><span class="parameter">args</span>
+            <span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.6">table</a></span>
+         Arguments for creating ioloop instance
+         (<em>optional</em>)
+        </li>
     </ul>
 
     <h3>Returns:</h3>
@@ -275,7 +280,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 2020-03-05 09:31:57 </i>
+<i style="float:right;">Last updated 2020-06-24 21:04:55 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/topics/LICENSE.html b/docs/topics/LICENSE.html
@@ -80,7 +80,7 @@ <h2>Examples</h2>
 </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 2020-03-05 09:31:57 </i>
+<i style="float:right;">Last updated 2020-06-24 21:04:55 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>