docs: add dummy jsdocs README

Signed-off-by: Jo-Philipp Wich <jo@mein.io>

diff --git a/docs/jsapi/LuCI.Class.html b/docs/jsapi/LuCI.Class.html
index c643a474ea8696e4ed4e69174745d7ee089c1f9e..c450ea455125b9ce617181b4b0808815090717e4 100644 (file)
--- a/docs/jsapi/LuCI.Class.html
+++ b/docs/jsapi/LuCI.Class.html
@@ -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>

diff --git a/docs/jsapi/LuCI.Headers.html b/docs/jsapi/LuCI.Headers.html
index e9abee54d6973dafcf5431afd8bba9139854c153..4cc80c93b2b5884e1e79d8db4eb11c318a226b12 100644 (file)
--- a/docs/jsapi/LuCI.Headers.html
+++ b/docs/jsapi/LuCI.Headers.html
@@ -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>

diff --git a/docs/jsapi/LuCI.Network.Device.html b/docs/jsapi/LuCI.Network.Device.html
index b624c947432848ecdfc783b168447043887884e6..7e7be6934408ef985278737557aad969006b2b90 100644 (file)
--- a/docs/jsapi/LuCI.Network.Device.html
+++ b/docs/jsapi/LuCI.Network.Device.html
@@ -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>

diff --git a/docs/jsapi/LuCI.Network.Hosts.html b/docs/jsapi/LuCI.Network.Hosts.html
index caca743e6f9656147245c04cfa1ade39fe87f445..09edd66d7ea0808bd405b6fff6a14206dc340b7a 100644 (file)
--- a/docs/jsapi/LuCI.Network.Hosts.html
+++ b/docs/jsapi/LuCI.Network.Hosts.html
@@ -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>

diff --git a/docs/jsapi/LuCI.Network.Protocol.html b/docs/jsapi/LuCI.Network.Protocol.html
index 9d399a8dc8ab2ea464350c0c1dfe76fe60676710..936f1a8b794f785f23d286e192697544c9ba43dd 100644 (file)
--- a/docs/jsapi/LuCI.Network.Protocol.html
+++ b/docs/jsapi/LuCI.Network.Protocol.html
@@ -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>

diff --git a/docs/jsapi/LuCI.Network.WifiDevice.html b/docs/jsapi/LuCI.Network.WifiDevice.html
index 3867110542946d2b751e95417350c2a58c209d6a..22d66bea06c32ac169069a4427ee07844063be9b 100644 (file)
--- a/docs/jsapi/LuCI.Network.WifiDevice.html
+++ b/docs/jsapi/LuCI.Network.WifiDevice.html
@@ -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>

diff --git a/docs/jsapi/LuCI.Network.WifiNetwork.html b/docs/jsapi/LuCI.Network.WifiNetwork.html
index 1e7d493379c14b2495c9783378c87b1aedfeb2eb..0c1abab888eb79d70ad2374f752853189b1ef1dc 100644 (file)
--- a/docs/jsapi/LuCI.Network.WifiNetwork.html
+++ b/docs/jsapi/LuCI.Network.WifiNetwork.html
@@ -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>

diff --git a/docs/jsapi/LuCI.Network.html b/docs/jsapi/LuCI.Network.html
index 0d40085275bb0b704fc4e965a1d987b7a04d814c..65c5d4de000378edc7a814aeb8f749864764863f 100644 (file)
--- a/docs/jsapi/LuCI.Network.html
+++ b/docs/jsapi/LuCI.Network.html
@@ -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>

diff --git a/docs/jsapi/LuCI.Poll.html b/docs/jsapi/LuCI.Poll.html
index 4e2b753c0a5e5cd4573aa2211fbf6a977c9c0091..f371e33d57439d76f815031555fca5733f942192 100644 (file)
--- a/docs/jsapi/LuCI.Poll.html
+++ b/docs/jsapi/LuCI.Poll.html
@@ -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>

diff --git a/docs/jsapi/LuCI.Request.html b/docs/jsapi/LuCI.Request.html
index 67523566e2e01bfaa5f0aae41d2efba6f63cd656..0201d9af109ea2e67435750f196eec5b090074b1 100644 (file)
--- a/docs/jsapi/LuCI.Request.html
+++ b/docs/jsapi/LuCI.Request.html
@@ -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>

diff --git a/docs/jsapi/LuCI.Request.poll.html b/docs/jsapi/LuCI.Request.poll.html
index 7699cb9dcff7d1e8245f11665a81be57e87cf06d..aad776035671b0f45e6f9f0f3ab21b8c091424b5 100644 (file)
--- a/docs/jsapi/LuCI.Request.poll.html
+++ b/docs/jsapi/LuCI.Request.poll.html
@@ -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>

diff --git a/docs/jsapi/LuCI.Response.html b/docs/jsapi/LuCI.Response.html
index dddbb6a623a32bc54b1565057faee9b3cc37f7ba..808a59039dee08b6b333ff93f78e7aea8fc8e5b4 100644 (file)
--- a/docs/jsapi/LuCI.Response.html
+++ b/docs/jsapi/LuCI.Response.html
@@ -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>

diff --git a/docs/jsapi/LuCI.XHR.html b/docs/jsapi/LuCI.XHR.html
index 7cbb6eaceebb4e40c63767271379d5e7281eaed6..6e028ccfc8360cc8d7be6fa941cd10a87b30285f 100644 (file)
--- a/docs/jsapi/LuCI.XHR.html
+++ b/docs/jsapi/LuCI.XHR.html
@@ -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>

diff --git a/docs/jsapi/LuCI.dom.html b/docs/jsapi/LuCI.dom.html
index d16eca167fd13ee12dfc9c2fa383dc0f1af54ed6..b24f7fb8f02b7ddc827cffce683696f18cb109c2 100644 (file)
--- a/docs/jsapi/LuCI.dom.html
+++ b/docs/jsapi/LuCI.dom.html
@@ -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>

diff --git a/docs/jsapi/LuCI.fs.html b/docs/jsapi/LuCI.fs.html
index cbc9c46b337e8f0e625fc1c3dc83129cd030d45f..194ba2b5ee93fad8491d489eb38b76ea49c4958f 100644 (file)
--- a/docs/jsapi/LuCI.fs.html
+++ b/docs/jsapi/LuCI.fs.html
@@ -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>

diff --git a/docs/jsapi/LuCI.html b/docs/jsapi/LuCI.html
index 99a874fcafd07f957c59576fe5b7e8e59e049eb8..20852da421b63af738f7386ddeec402672497b96 100644 (file)
--- a/docs/jsapi/LuCI.html
+++ b/docs/jsapi/LuCI.html
@@ -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>

diff --git a/docs/jsapi/LuCI.rpc.html b/docs/jsapi/LuCI.rpc.html
index 7515462e33ecfe538eada7c2d18d7c5bab269fb7..8f36226bf9434db6f98866fc95ebfc3bb71e6556 100644 (file)
--- a/docs/jsapi/LuCI.rpc.html
+++ b/docs/jsapi/LuCI.rpc.html
@@ -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>

diff --git a/docs/jsapi/LuCI.uci.html b/docs/jsapi/LuCI.uci.html
index e88dae9827b04216d1fcfd0862a8f863b714c369..3d1824f608ea35a947fe0d4bf284071f08b5aeb4 100644 (file)
--- a/docs/jsapi/LuCI.uci.html
+++ b/docs/jsapi/LuCI.uci.html
@@ -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>

diff --git a/docs/jsapi/LuCI.view.html b/docs/jsapi/LuCI.view.html
index c1e76c9d028f63caa3274a2661a8f4574822890e..39c71defa97ef0be49478b6ccef38e1156f46a98 100644 (file)
--- a/docs/jsapi/LuCI.view.html
+++ b/docs/jsapi/LuCI.view.html
@@ -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
+++ b/docs/jsapi/README.md
@@ -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).

diff --git a/docs/jsapi/index.html b/docs/jsapi/index.html
index 2e4de44fd027e7621e44a201847fd58b07b15776..5c993a286c46bbf7575fa06677d90281ad5cb46e 100644 (file)
--- a/docs/jsapi/index.html
+++ b/docs/jsapi/index.html
@@ -1085,32 +1085,9 @@
 
 
     <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>
 
 
@@ -1121,7 +1098,7 @@
         
 
         <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/jsdoc.conf.json b/jsdoc.conf.json
index b1b508f31d4cf8b6384f27dc91068f5b78df83cd..d35fd5999c285128d477af2360d3b86ea39f0037 100644 (file)
--- a/jsdoc.conf.json
+++ b/jsdoc.conf.json
@@ -17,6 +17,6 @@
     "opts": {
         "destination": "docs/jsapi",
         "recurse": true,
-        "readme": "README.md"
+        "readme": "docs/jsapi/README.md"
     }
 }