OSDN Git Service

docs: add dummy jsdocs README
authorJo-Philipp Wich <jo@mein.io>
Tue, 5 Nov 2019 15:32:21 +0000 (16:32 +0100)
committerJo-Philipp Wich <jo@mein.io>
Tue, 5 Nov 2019 15:32:21 +0000 (16:32 +0100)
Signed-off-by: Jo-Philipp Wich <jo@mein.io>
22 files changed:
docs/jsapi/LuCI.Class.html
docs/jsapi/LuCI.Headers.html
docs/jsapi/LuCI.Network.Device.html
docs/jsapi/LuCI.Network.Hosts.html
docs/jsapi/LuCI.Network.Protocol.html
docs/jsapi/LuCI.Network.WifiDevice.html
docs/jsapi/LuCI.Network.WifiNetwork.html
docs/jsapi/LuCI.Network.html
docs/jsapi/LuCI.Poll.html
docs/jsapi/LuCI.Request.html
docs/jsapi/LuCI.Request.poll.html
docs/jsapi/LuCI.Response.html
docs/jsapi/LuCI.XHR.html
docs/jsapi/LuCI.dom.html
docs/jsapi/LuCI.fs.html
docs/jsapi/LuCI.html
docs/jsapi/LuCI.rpc.html
docs/jsapi/LuCI.uci.html
docs/jsapi/LuCI.view.html
docs/jsapi/README.md [new file with mode: 0644]
docs/jsapi/index.html
jsdoc.conf.json

index c643a47..c450ea4 100644 (file)
@@ -2312,7 +2312,7 @@ and the values extracted from the <code>args</code> array beginning with
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index e9abee5..4cc80c9 100644 (file)
@@ -1485,7 +1485,7 @@ Note: Header-Names are case-insensitive.</p>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index b624c94..7e7be69 100644 (file)
@@ -3430,7 +3430,7 @@ when it is down or absent.</td>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index caca743..09edd66 100644 (file)
@@ -2411,7 +2411,7 @@ is used as hint.</td>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index 9d399a8..936f1a8 100644 (file)
@@ -5384,7 +5384,7 @@ configuration.</p></td>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index 3867110..22d66be 100644 (file)
@@ -2777,7 +2777,7 @@ configuration.</p></td>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index 1e7d493..0c1abab 100644 (file)
@@ -4898,7 +4898,7 @@ configuration.</p></td>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index 0d40085..65c5d4d 100644 (file)
@@ -7022,7 +7022,7 @@ conjunction with <code>quality</code> to calculate a quality percentage.</p></td
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index 4e2b753..f371e33 100644 (file)
@@ -1868,7 +1868,7 @@ run to begin with.</td>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index 6752356..0201d9a 100644 (file)
@@ -2764,7 +2764,7 @@ instances as sole argument during the HTTP request transfer.</p></td>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index 7699cb9..aad7760 100644 (file)
@@ -1987,7 +1987,7 @@ else <code>null</code>.</p></td>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index dddbb6a..808a590 100644 (file)
@@ -1845,7 +1845,7 @@ using <code>String()</code> and treated as response text.</p></td>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index 7cbb6ea..6e028cc 100644 (file)
@@ -2037,7 +2037,7 @@ when invoked.</p>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index d16eca1..b24f7fb 100644 (file)
@@ -3868,7 +3868,7 @@ ignored, else not.</p>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index cbc9c46..194ba2b 100644 (file)
@@ -2977,7 +2977,7 @@ the failure reason.</td>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index 99a874f..20852da 100644 (file)
@@ -5013,7 +5013,7 @@ else <code>null</code>.</p></td>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index 7515462..8f36226 100644 (file)
@@ -3215,7 +3215,7 @@ to the <code>expect</code> and <code>filter</code> declarations.</td>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index e88dae9..3d1824f 100644 (file)
@@ -4763,7 +4763,7 @@ associated name as arguments.</p>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index c1e76c9..39c71de 100644 (file)
@@ -2073,7 +2073,7 @@ to a <code>Node</code> value.</td>
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
diff --git a/docs/jsapi/README.md b/docs/jsapi/README.md
new file mode 100644 (file)
index 0000000..41dd17b
--- /dev/null
@@ -0,0 +1,4 @@
+# LuCI client side API documentation
+
+You can browse the JavaScript apis provided by LuCI here. A good starting point is the central
+[luci.js class](LuCI.html).
index 2e4de44..5c993a2 100644 (file)
 
 
     <section>
-        <article class="readme"><h1>OpenWrt luci feed</h1>
-<p><a target="_blank" href="https://hosted.weblate.org/engage/openwrt/?utm_source=widget"><img src="https://hosted.weblate.org/widgets/openwrt/-/svg-badge.svg" alt="Translation status"></a></p>
-<h2>Description</h2>
-<p>This is the OpenWrt &quot;luci&quot;-feed containing LuCI - OpenWrt Configuration Interface.</p>
-<h2>Usage</h2>
-<p>This feed is enabled by default. Your feeds.conf.default (or feeds.conf) should contain a line like:</p>
-<pre class="prettyprint source"><code>src-git luci https://github.com/openwrt/luci.git
-</code></pre>
-<p>To install all its package definitions, run:</p>
-<pre class="prettyprint source"><code>./scripts/feeds update luci
-./scripts/feeds install -a -p luci
-</code></pre>
-<h2>API Reference</h2>
-<p>You can browse the generated API documentation directly on Github.</p>
-<ul>
-<li><a target="_blank" href="http://htmlpreview.github.io/?http://raw.githubusercontent.com/openwrt/luci/master/docs/api/index.html">Server side Lua APIs</a></li>
-<li><a target="_blank" href="http://htmlpreview.github.io/?http://raw.githubusercontent.com/openwrt/luci/master/docs/jsapi/index.html">Client side JavaScript APIs</a></li>
-</ul>
-<h2>Development</h2>
-<p>Documentation for developing and extending LuCI can be found <a target="_blank" href="https://github.com/openwrt/luci/wiki">in the Wiki</a></p>
-<h2>License</h2>
-<p>See <a href="LICENSE">LICENSE</a> file.</p>
-<h2>Package Guidelines</h2>
-<p>See <a href="CONTRIBUTING.md">CONTRIBUTING.md</a> file.</p>
-<h2>Translation status</h2>
-<p><a target="_blank" href="https://hosted.weblate.org/engage/openwrt/?utm_source=widget"><img src="https://hosted.weblate.org/widgets/openwrt/-/multi-auto.svg" alt="Translation status"></a></p></article>
+        <article class="readme"><h1>LuCI client side API documentation</h1>
+<p>You can browse the JavaScript apis provided by LuCI here. A good starting point is the central
+<a href="LuCI.html">luci.js class</a>.</p></article>
     </section>
 
 
         
 
         <footer>
-            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time)
+            Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
         </footer>
     </div>
 </div>
index b1b508f..d35fd59 100644 (file)
@@ -17,6 +17,6 @@
     "opts": {
         "destination": "docs/jsapi",
         "recurse": true,
-        "readme": "README.md"
+        "readme": "docs/jsapi/README.md"
     }
 }