Commit 489fc4b2 authored by Jo-Philipp Wich's avatar Jo-Philipp Wich
Browse files

docs: various updates



 - jsapi: include source links
 - README.md: link to github pages
 - docs/README.md: add stub index page
Signed-off-by: default avatarJo-Philipp Wich <jo@mein.io>
parent 9933dd64
......@@ -23,8 +23,8 @@ To install all its package definitions, run:
You can browse the generated API documentation directly on Github.
- [Server side Lua APIs](http://htmlpreview.github.io/?http://raw.githubusercontent.com/openwrt/luci/master/docs/api/index.html)
- [Client side JavaScript APIs](http://htmlpreview.github.io/?http://raw.githubusercontent.com/openwrt/luci/master/docs/jsapi/index.html)
- [Server side Lua APIs](http://openwrt.github.io/luci/api/index.html)
- [Client side JavaScript APIs](http://openwrt.github.io/luci/jsapi/index.html)
## Development
......
# LuCI Documentation
## API Reference
- [Client side JavaScript APIs](jsapi/index.html)
- [Server side Lua APIs](api/index.html)
......@@ -17,7 +17,7 @@
<script>
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{}};
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{"outputSourceFiles":true}};
</script>
......@@ -1104,7 +1104,7 @@ implements prototypal inheritance.</p></div>
<div class="tag-source">
luci.js, line 59
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line59">line 59</a>
</div>
</div>
......@@ -1189,7 +1189,7 @@ implements prototypal inheritance.</p></div>
<div class="tag-source">
luci.js, line 87
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line87">line 87</a>
</div>
</div>
......@@ -1339,7 +1339,7 @@ class constructor and can be instantiated with <code>new</code>.</td>
<div class="tag-source">
luci.js, line 169
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line169">line 169</a>
</div>
</div>
......@@ -1526,7 +1526,7 @@ enable inheritance.</td>
<div class="tag-source">
luci.js, line 195
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line195">line 195</a>
</div>
</div>
......@@ -1673,7 +1673,7 @@ a subclass of this class'.</td>
<div class="tag-source">
luci.js, line 145
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line145">line 145</a>
</div>
</div>
......@@ -1865,7 +1865,7 @@ enable inheritance.</td>
<div class="tag-source">
luci.js, line 267
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line267">line 267</a>
</div>
</div>
......@@ -2095,7 +2095,7 @@ superclass method returned <code>null</code>.</td>
<div class="tag-source">
luci.js, line 225
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line225">line 225</a>
</div>
</div>
......@@ -2318,7 +2318,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 Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Nov 07 2019 12:36:05 GMT+0100 (Central European Standard Time)
</footer>
</div>
</div>
......
......@@ -17,7 +17,7 @@
<script>
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{}};
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{"outputSourceFiles":true}};
</script>
......@@ -1103,7 +1103,7 @@ response objects using the <code>response.headers</code> property.</p></div>
<div class="tag-source">
luci.js, line 324
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line324">line 324</a>
</div>
</div>
......@@ -1188,7 +1188,7 @@ response objects using the <code>response.headers</code> property.</p></div>
<div class="tag-source">
luci.js, line 363
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line363">line 363</a>
</div>
</div>
......@@ -1337,7 +1337,7 @@ Note: Header-Names are case-insensitive.</p>
<div class="tag-source">
luci.js, line 347
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line347">line 347</a>
</div>
</div>
......@@ -1491,7 +1491,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 Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Nov 07 2019 12:36:06 GMT+0100 (Central European Standard Time)
</footer>
</div>
</div>
......
......@@ -17,7 +17,7 @@
<script>
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{}};
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{"outputSourceFiles":true}};
</script>
......@@ -1103,7 +1103,7 @@ device and allows querying device details such as packet statistics or MTU.</p><
<div class="tag-source">
network.js, line 2649
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2649">line 2649</a>
</div>
</div>
......@@ -1188,7 +1188,7 @@ device and allows querying device details such as packet statistics or MTU.</p><
<div class="tag-source">
network.js, line 2856
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2856">line 2856</a>
</div>
</div>
......@@ -1292,7 +1292,7 @@ device is not a Linux bridge.</td>
<div class="tag-source">
network.js, line 2868
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2868">line 2868</a>
</div>
</div>
......@@ -1393,7 +1393,7 @@ enabled, else <code>false</code>.</td>
<div class="tag-source">
network.js, line 2783
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2783">line 2783</a>
</div>
</div>
......@@ -1494,7 +1494,7 @@ for non-wifi devices or operation mode and ssid for wifi ones.</td>
<div class="tag-source">
network.js, line 2727
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2727">line 2727</a>
</div>
</div>
......@@ -1594,7 +1594,7 @@ for non-wifi devices or operation mode and ssid for wifi ones.</td>
<div class="tag-source">
network.js, line 2716
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2716">line 2716</a>
</div>
</div>
......@@ -1694,7 +1694,7 @@ for non-wifi devices or operation mode and ssid for wifi ones.</td>
<div class="tag-source">
network.js, line 2695
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2695">line 2695</a>
</div>
</div>
......@@ -1798,7 +1798,7 @@ e.g. for non-ethernet tunnel devices.</td>
<div class="tag-source">
network.js, line 2706
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2706">line 2706</a>
</div>
</div>
......@@ -1898,7 +1898,7 @@ e.g. for non-ethernet tunnel devices.</td>
<div class="tag-source">
network.js, line 2684
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2684">line 2684</a>
</div>
</div>
......@@ -1998,7 +1998,7 @@ e.g. for non-ethernet tunnel devices.</td>
<div class="tag-source">
network.js, line 2963
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2963">line 2963</a>
</div>
</div>
......@@ -2103,7 +2103,7 @@ assigned to any logical interface.</td>
<div class="tag-source">
network.js, line 2974
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2974">line 2974</a>
</div>
</div>
......@@ -2204,7 +2204,7 @@ logical interfaces this device is assigned to.</td>
<div class="tag-source">
network.js, line 2834
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2834">line 2834</a>
</div>
</div>
......@@ -2309,7 +2309,7 @@ a Linux bridge.</td>
<div class="tag-source">
network.js, line 2928
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2928">line 2928</a>
</div>
</div>
......@@ -2409,7 +2409,7 @@ a Linux bridge.</td>
<div class="tag-source">
network.js, line 2950
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2950">line 2950</a>
</div>
</div>
......@@ -2509,7 +2509,7 @@ a Linux bridge.</td>
<div class="tag-source">
network.js, line 2769
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2769">line 2769</a>
</div>
</div>
......@@ -2610,7 +2610,7 @@ the operation mode and SSID for wifi devices.</td>
<div class="tag-source">
network.js, line 2917
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2917">line 2917</a>
</div>
</div>
......@@ -2710,7 +2710,7 @@ the operation mode and SSID for wifi devices.</td>
<div class="tag-source">
network.js, line 2939
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2939">line 2939</a>
</div>
</div>
......@@ -2810,7 +2810,7 @@ the operation mode and SSID for wifi devices.</td>
<div class="tag-source">
network.js, line 2745
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2745">line 2745</a>
</div>
</div>
......@@ -2919,7 +2919,7 @@ the operation mode and SSID for wifi devices.</td>
<div class="tag-source">
network.js, line 2801
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2801">line 2801</a>
</div>
</div>
......@@ -3020,7 +3020,7 @@ the operation mode and SSID for wifi devices.</td>
<div class="tag-source">
network.js, line 2998
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2998">line 2998</a>
</div>
</div>
......@@ -3125,7 +3125,7 @@ is not a wireless device.</td>
<div class="tag-source">
network.js, line 2896
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2896">line 2896</a>
</div>
</div>
......@@ -3226,7 +3226,7 @@ else <code>false</code>.</td>
<div class="tag-source">
network.js, line 2907
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2907">line 2907</a>
</div>
</div>
......@@ -3327,7 +3327,7 @@ else <code>false</code>.</td>
<div class="tag-source">
network.js, line 2880
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2880">line 2880</a>
</div>
</div>
......@@ -3436,7 +3436,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 Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Nov 07 2019 12:36:06 GMT+0100 (Central European Standard Time)
</footer>
</div>
</div>
......
......@@ -17,7 +17,7 @@
<script>
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{}};
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{"outputSourceFiles":true}};
</script>
......@@ -1104,7 +1104,7 @@ host information by different criteria.</p></div>
<div class="tag-source">
network.js, line 1684
<a href="network.js.html">network.js</a>, <a href="network.js.html#line1684">line 1684</a>
</div>
</div>
......@@ -1189,7 +1189,7 @@ host information by different criteria.</p></div>
<div class="tag-source">
network.js, line 1781
<a href="network.js.html">network.js</a>, <a href="network.js.html#line1781">line 1781</a>
</div>
</div>
......@@ -1339,7 +1339,7 @@ the corresponding host.</td>
<div class="tag-source">
network.js, line 1745
<a href="network.js.html">network.js</a>, <a href="network.js.html#line1745">line 1745</a>
</div>
</div>
......@@ -1489,7 +1489,7 @@ the corresponding host.</td>
<div class="tag-source">
network.js, line 1700
<a href="network.js.html">network.js</a>, <a href="network.js.html#line1700">line 1700</a>
</div>
</div>
......@@ -1639,7 +1639,7 @@ the corresponding host.</td>
<div class="tag-source">
network.js, line 1730
<a href="network.js.html">network.js</a>, <a href="network.js.html#line1730">line 1730</a>
</div>
</div>
......@@ -1789,7 +1789,7 @@ the corresponding host.</td>
<div class="tag-source">
network.js, line 1715
<a href="network.js.html">network.js</a>, <a href="network.js.html#line1715">line 1715</a>
</div>
</div>
......@@ -1939,7 +1939,7 @@ the corresponding host.</td>
<div class="tag-source">
network.js, line 1799
<a href="network.js.html">network.js</a>, <a href="network.js.html#line1799">line 1799</a>
</div>
</div>
......@@ -2089,7 +2089,7 @@ the corresponding host.</td>
<div class="tag-source">
network.js, line 1763
<a href="network.js.html">network.js</a>, <a href="network.js.html#line1763">line 1763</a>
</div>
</div>
......@@ -2239,7 +2239,7 @@ the corresponding host.</td>
<div class="tag-source">
network.js, line 1827
<a href="network.js.html">network.js</a>, <a href="network.js.html#line1827">line 1827</a>
</div>
</div>
......@@ -2417,7 +2417,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 Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Nov 07 2019 12:36:06 GMT+0100 (Central European Standard Time)
</footer>
</div>
</div>
......
......@@ -17,7 +17,7 @@
<script>
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{}};
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{"outputSourceFiles":true}};
</script>
......@@ -1103,7 +1103,7 @@ subclasses which describe logical UCI networks defined by <code>config interface
<div class="tag-source">
network.js, line 1850
<a href="network.js.html">network.js</a>, <a href="network.js.html#line1850">line 1850</a>
</div>
</div>
......@@ -1188,7 +1188,7 @@ subclasses which describe logical UCI networks defined by <code>config interface
<div class="tag-source">
network.js, line 2439
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2439">line 2439</a>
</div>
</div>
......@@ -1349,7 +1349,7 @@ interface or if the logical interface is virtual.</td>
<div class="tag-source">
network.js, line 2608
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2608">line 2608</a>
</div>
</div>
......@@ -1510,7 +1510,7 @@ device or <code>false</code> if not.</td>
<div class="tag-source">
network.js, line 2466
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2466">line 2466</a>
</div>
</div>
......@@ -1671,7 +1671,7 @@ interface or if the logical interface is virtual.</td>
<div class="tag-source">
network.js, line 1883
<a href="network.js.html">network.js</a>, <a href="network.js.html#line1883">line 1883</a>
</div>
</div>
......@@ -1823,7 +1823,7 @@ not found.</td>
<div class="tag-source">
network.js, line 2493
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2493">line 2493</a>
</div>
</div>
......@@ -1925,7 +1925,7 @@ expected Linux network device according to the configuration.</td>
<div class="tag-source">
network.js, line 2554
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2554">line 2554</a>
</div>
</div>
......@@ -2032,7 +2032,7 @@ virtual and not a bridge.</td>
<div class="tag-source">
network.js, line 2208
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2208">line 2208</a>
</div>
</div>
......@@ -2133,7 +2133,7 @@ protocol backend.</td>
<div class="tag-source">
network.js, line 2120
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2120">line 2120</a>
</div>
</div>
......@@ -2234,7 +2234,7 @@ protocol backend.</td>
<div class="tag-source">
network.js, line 2252
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2252">line 2252</a>
</div>
</div>
......@@ -2342,7 +2342,7 @@ error code in case no translation can be found.</p>
<div class="tag-source">
network.js, line 2003
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2003">line 2003</a>
</div>
</div>
......@@ -2446,7 +2446,7 @@ if it isn't applicable to the associated protocol.</td>
<div class="tag-source">
network.js, line 2188
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2188">line 2188</a>
</div>
</div>
......@@ -2548,7 +2548,7 @@ default route or <code>null</code> if no default route was found.</td>
<div class="tag-source">
network.js, line 2100
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2100">line 2100</a>
</div>
</div>
......@@ -2650,7 +2650,7 @@ default route or <code>null</code> if no default route was found.</td>
<div class="tag-source">
network.js, line 1948
<a href="network.js.html">network.js</a>, <a href="network.js.html#line1948">line 1948</a>
</div>
</div>
......@@ -2752,7 +2752,7 @@ default route or <code>null</code> if no default route was found.</td>
<div class="tag-source">
network.js, line 1908
<a href="network.js.html">network.js</a>, <a href="network.js.html#line1908">line 1908</a>
</div>
</div>
......@@ -2856,7 +2856,7 @@ it could not be determined.</td>
<div class="tag-source">
network.js, line 2139
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2139">line 2139</a>
</div>
</div>
......@@ -2960,7 +2960,7 @@ in CIDR notation or <code>null</code> if no IPv6 addresses were set.</td>
<div class="tag-source">
network.js, line 2161
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2161">line 2161</a>
</div>
</div>
......@@ -3062,7 +3062,7 @@ follows the order of the addresses in <code>ubus</code> runtime information.</td
<div class="tag-source">
network.js, line 2227
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2227">line 2227</a>
</div>
</div>
......@@ -3166,7 +3166,7 @@ handler or <code>null</code> if no prefix is present.</td>
<div class="tag-source">
network.js, line 2055
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2055">line 2055</a>