From 66fc653b099e619e0fcb57b78311f0f13e4b3ccd Mon Sep 17 00:00:00 2001 From: Jo-Philipp Wich Date: Tue, 5 Nov 2019 16:32:21 +0100 Subject: docs: add dummy jsdocs README Signed-off-by: Jo-Philipp Wich --- docs/jsapi/LuCI.Class.html | 2 +- docs/jsapi/LuCI.Headers.html | 2 +- docs/jsapi/LuCI.Network.Device.html | 2 +- docs/jsapi/LuCI.Network.Hosts.html | 2 +- docs/jsapi/LuCI.Network.Protocol.html | 2 +- docs/jsapi/LuCI.Network.WifiDevice.html | 2 +- docs/jsapi/LuCI.Network.WifiNetwork.html | 2 +- docs/jsapi/LuCI.Network.html | 2 +- docs/jsapi/LuCI.Poll.html | 2 +- docs/jsapi/LuCI.Request.html | 2 +- docs/jsapi/LuCI.Request.poll.html | 2 +- docs/jsapi/LuCI.Response.html | 2 +- docs/jsapi/LuCI.XHR.html | 2 +- docs/jsapi/LuCI.dom.html | 2 +- docs/jsapi/LuCI.fs.html | 2 +- docs/jsapi/LuCI.html | 2 +- docs/jsapi/LuCI.rpc.html | 2 +- docs/jsapi/LuCI.uci.html | 2 +- docs/jsapi/LuCI.view.html | 2 +- docs/jsapi/README.md | 4 ++++ docs/jsapi/index.html | 31 ++++--------------------------- 21 files changed, 27 insertions(+), 46 deletions(-) create mode 100644 docs/jsapi/README.md (limited to 'docs/jsapi') 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 args array beginning with
- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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.

- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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.
- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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.
- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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.

- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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.

- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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.

- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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 quality to calculate a quality percentage.

- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time) 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.
- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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.

- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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 null.

- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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 String() and treated as response text.

- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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.

- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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.

- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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.
- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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 null.

- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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 expect and filter declarations.
- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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.

- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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 Node value.
- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:49:52 GMT+0100 (Central European Standard Time) + Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 16:31:40 GMT+0100 (Central European Standard Time)
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 @@
-

OpenWrt luci feed

-

Translation status

-

Description

-

This is the OpenWrt "luci"-feed containing LuCI - OpenWrt Configuration Interface.

-

Usage

-

This feed is enabled by default. Your feeds.conf.default (or feeds.conf) should contain a line like:

-
src-git luci https://github.com/openwrt/luci.git
-
-

To install all its package definitions, run:

-
./scripts/feeds update luci
-./scripts/feeds install -a -p luci
-
-

API Reference

-

You can browse the generated API documentation directly on Github.

- -

Development

-

Documentation for developing and extending LuCI can be found in the Wiki

-

License

-

See LICENSE file.

-

Package Guidelines

-

See CONTRIBUTING.md file.

-

Translation status

-

Translation status

+

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.

@@ -1121,7 +1098,7 @@ -- cgit v1.2.3