diff options
author | Jo-Philipp Wich <jo@mein.io> | 2019-11-05 16:32:21 +0100 |
---|---|---|
committer | Jo-Philipp Wich <jo@mein.io> | 2019-11-05 16:32:21 +0100 |
commit | 66fc653b099e619e0fcb57b78311f0f13e4b3ccd (patch) | |
tree | 14b35706b1fda38cd62b3ea8f900037041a36bda | |
parent | 937a51859dc82993aed83c8a2aeb86af30ae6563 (diff) |
docs: add dummy jsdocs README
Signed-off-by: Jo-Philipp Wich <jo@mein.io>
-rw-r--r-- | docs/jsapi/LuCI.Class.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.Headers.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.Network.Device.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.Network.Hosts.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.Network.Protocol.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.Network.WifiDevice.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.Network.WifiNetwork.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.Network.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.Poll.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.Request.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.Request.poll.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.Response.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.XHR.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.dom.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.fs.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.rpc.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.uci.html | 2 | ||||
-rw-r--r-- | docs/jsapi/LuCI.view.html | 2 | ||||
-rw-r--r-- | docs/jsapi/README.md | 4 | ||||
-rw-r--r-- | docs/jsapi/index.html | 31 | ||||
-rw-r--r-- | jsdoc.conf.json | 2 |
22 files changed, 28 insertions, 47 deletions
diff --git a/docs/jsapi/LuCI.Class.html b/docs/jsapi/LuCI.Class.html index c643a474e..c450ea455 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 e9abee54d..4cc80c93b 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 b624c9474..7e7be6934 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 caca743e6..09edd66d7 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 9d399a8dc..936f1a8b7 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 386711054..22d66bea0 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 1e7d49337..0c1abab88 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 0d4008527..65c5d4de0 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 4e2b753c0..f371e33d5 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 67523566e..0201d9af1 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 7699cb9dc..aad776035 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 dddbb6a62..808a59039 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 7cbb6eace..6e028ccfc 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 d16eca167..b24f7fb8f 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 cbc9c46b3..194ba2b5e 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 99a874fca..20852da42 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 7515462e3..8f36226bf 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 e88dae982..3d1824f60 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 c1e76c9d0..39c71defa 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 000000000..41dd17b64 --- /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 2e4de44fd..5c993a286 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 "luci"-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 b1b508f31..d35fd5999 100644 --- 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" } } |