summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/jsapi/LuCI.Class.html2
-rw-r--r--docs/jsapi/LuCI.Headers.html2
-rw-r--r--docs/jsapi/LuCI.Network.Device.html2
-rw-r--r--docs/jsapi/LuCI.Network.Hosts.html2
-rw-r--r--docs/jsapi/LuCI.Network.Protocol.html2
-rw-r--r--docs/jsapi/LuCI.Network.WifiDevice.html2
-rw-r--r--docs/jsapi/LuCI.Network.WifiNetwork.html2
-rw-r--r--docs/jsapi/LuCI.Network.html2
-rw-r--r--docs/jsapi/LuCI.Poll.html2
-rw-r--r--docs/jsapi/LuCI.Request.html2
-rw-r--r--docs/jsapi/LuCI.Request.poll.html2
-rw-r--r--docs/jsapi/LuCI.Response.html2
-rw-r--r--docs/jsapi/LuCI.XHR.html2
-rw-r--r--docs/jsapi/LuCI.dom.html2
-rw-r--r--docs/jsapi/LuCI.fs.html2
-rw-r--r--docs/jsapi/LuCI.html2
-rw-r--r--docs/jsapi/LuCI.rpc.html2
-rw-r--r--docs/jsapi/LuCI.uci.html2
-rw-r--r--docs/jsapi/LuCI.view.html2
-rw-r--r--docs/jsapi/README.md4
-rw-r--r--docs/jsapi/index.html31
21 files changed, 27 insertions, 46 deletions
diff --git a/docs/jsapi/LuCI.Class.html b/docs/jsapi/LuCI.Class.html
index c643a474ea..c450ea4551 100644
--- 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 e9abee54d6..4cc80c93b2 100644
--- 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 b624c94743..7e7be69344 100644
--- 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 caca743e6f..09edd66d7e 100644
--- 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 9d399a8dc8..936f1a8b79 100644
--- 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 3867110542..22d66bea06 100644
--- 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 1e7d493379..0c1abab888 100644
--- 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 0d40085275..65c5d4de00 100644
--- 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 4e2b753c0a..f371e33d57 100644
--- 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 67523566e2..0201d9af10 100644
--- 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 7699cb9dcf..aad7760356 100644
--- 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 dddbb6a623..808a59039d 100644
--- 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 7cbb6eacee..6e028ccfc8 100644
--- 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 d16eca167f..b24f7fb8f0 100644
--- 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 cbc9c46b33..194ba2b5ee 100644
--- 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 99a874fcaf..20852da421 100644
--- 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 7515462e33..8f36226bf9 100644
--- 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 e88dae9827..3d1824f608 100644
--- 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 c1e76c9d02..39c71defa9 100644
--- 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
index 0000000000..41dd17b641
--- /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 2e4de44fd0..5c993a286c 100644
--- 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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-18 04:20:50 +0000