Skip to content

Commit 489fc4b

Browse files
jow-jow-
committed
docs: various updates
 - jsapi: include source links - README.md: link to github pages - docs/README.md: add stub index page Signed-off-by: Jo-Philipp Wich <[email protected]>
1 parent 9933dd6 commit 489fc4b

29 files changed

+5855
-503
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ To install all its package definitions, run:
2323

2424
You can browse the generated API documentation directly on Github.
2525

26-
- [Server side Lua APIs](http://htmlpreview.github.io/?http://raw.githubusercontent.com/openwrt/luci/master/docs/api/index.html)
27-
- [Client side JavaScript APIs](http://htmlpreview.github.io/?http://raw.githubusercontent.com/openwrt/luci/master/docs/jsapi/index.html)
26+
- [Server side Lua APIs](http://openwrt.github.io/luci/api/index.html)
27+
- [Client side JavaScript APIs](http://openwrt.github.io/luci/jsapi/index.html)
2828

2929
## Development
3030

‎docs/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# LuCI Documentation
2+
3+
## API Reference
4+
5+
- [Client side JavaScript APIs](jsapi/index.html)
6+
- [Server side Lua APIs](api/index.html)

‎docs/jsapi/LuCI.Class.html‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818

1919
<script>
20-
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{}};
20+
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{"outputSourceFiles":true}};
2121
</script>
2222

2323

@@ -1104,7 +1104,7 @@ <h4 class="name" id="Class">
11041104

11051105

11061106
<div class="tag-source">
1107-
luci.js, line 59
1107+
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line59">line 59</a>
11081108
</div>
11091109

11101110
</div>
@@ -1189,7 +1189,7 @@ <h4 class="name" id=".extend">
11891189

11901190

11911191
<div class="tag-source">
1192-
luci.js, line 87
1192+
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line87">line 87</a>
11931193
</div>
11941194

11951195
</div>
@@ -1339,7 +1339,7 @@ <h4 class="name" id=".instantiate">
13391339

13401340

13411341
<div class="tag-source">
1342-
luci.js, line 169
1342+
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line169">line 169</a>
13431343
</div>
13441344

13451345
</div>
@@ -1526,7 +1526,7 @@ <h4 class="name" id=".isSubclass">
15261526

15271527

15281528
<div class="tag-source">
1529-
luci.js, line 195
1529+
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line195">line 195</a>
15301530
</div>
15311531

15321532
</div>
@@ -1673,7 +1673,7 @@ <h4 class="name" id=".singleton">
16731673

16741674

16751675
<div class="tag-source">
1676-
luci.js, line 145
1676+
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line145">line 145</a>
16771677
</div>
16781678

16791679
</div>
@@ -1865,7 +1865,7 @@ <h4 class="name" id="super">
18651865

18661866

18671867
<div class="tag-source">
1868-
luci.js, line 267
1868+
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line267">line 267</a>
18691869
</div>
18701870

18711871
</div>
@@ -2095,7 +2095,7 @@ <h4 class="name" id="varargs">
20952095

20962096

20972097
<div class="tag-source">
2098-
luci.js, line 225
2098+
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line225">line 225</a>
20992099
</div>
21002100

21012101
</div>
@@ -2318,7 +2318,7 @@ <h5>Returns:</h5>
23182318

23192319

23202320
<footer>
2321-
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)
2321+
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)
23222322
</footer>
23232323
</div>
23242324
</div>

‎docs/jsapi/LuCI.Headers.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818

1919
<script>
20-
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{}};
20+
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{"outputSourceFiles":true}};
2121
</script>
2222

2323

@@ -1103,7 +1103,7 @@ <h4 class="name" id="Headers">
11031103

11041104

11051105
<div class="tag-source">
1106-
luci.js, line 324
1106+
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line324">line 324</a>
11071107
</div>
11081108

11091109
</div>
@@ -1188,7 +1188,7 @@ <h4 class="name" id="get">
11881188

11891189

11901190
<div class="tag-source">
1191-
luci.js, line 363
1191+
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line363">line 363</a>
11921192
</div>
11931193

11941194
</div>
@@ -1337,7 +1337,7 @@ <h4 class="name" id="has">
13371337

13381338

13391339
<div class="tag-source">
1340-
luci.js, line 347
1340+
<a href="luci.js.html">luci.js</a>, <a href="luci.js.html#line347">line 347</a>
13411341
</div>
13421342

13431343
</div>
@@ -1491,7 +1491,7 @@ <h5>Returns:</h5>
14911491

14921492

14931493
<footer>
1494-
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)
1494+
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)
14951495
</footer>
14961496
</div>
14971497
</div>

‎docs/jsapi/LuCI.Network.Device.html‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818

1919
<script>
20-
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{}};
20+
var config = {"monospaceLinks":true,"cleverLinks":true,"default":{"outputSourceFiles":true}};
2121
</script>
2222

2323

@@ -1103,7 +1103,7 @@ <h4 class="name" id="Device">
11031103

11041104

11051105
<div class="tag-source">
1106-
network.js, line 2649
1106+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2649">line 2649</a>
11071107
</div>
11081108

11091109
</div>
@@ -1188,7 +1188,7 @@ <h4 class="name" id="getBridgeID">
11881188

11891189

11901190
<div class="tag-source">
1191-
network.js, line 2856
1191+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2856">line 2856</a>
11921192
</div>
11931193

11941194
</div>
@@ -1292,7 +1292,7 @@ <h4 class="name" id="getBridgeSTP">
12921292

12931293

12941294
<div class="tag-source">
1295-
network.js, line 2868
1295+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2868">line 2868</a>
12961296
</div>
12971297

12981298
</div>
@@ -1393,7 +1393,7 @@ <h4 class="name" id="getI18n">
13931393

13941394

13951395
<div class="tag-source">
1396-
network.js, line 2783
1396+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2783">line 2783</a>
13971397
</div>
13981398

13991399
</div>
@@ -1494,7 +1494,7 @@ <h4 class="name" id="getIP6Addrs">
14941494

14951495

14961496
<div class="tag-source">
1497-
network.js, line 2727
1497+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2727">line 2727</a>
14981498
</div>
14991499

15001500
</div>
@@ -1594,7 +1594,7 @@ <h4 class="name" id="getIPAddrs">
15941594

15951595

15961596
<div class="tag-source">
1597-
network.js, line 2716
1597+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2716">line 2716</a>
15981598
</div>
15991599

16001600
</div>
@@ -1694,7 +1694,7 @@ <h4 class="name" id="getMAC">
16941694

16951695

16961696
<div class="tag-source">
1697-
network.js, line 2695
1697+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2695">line 2695</a>
16981698
</div>
16991699

17001700
</div>
@@ -1798,7 +1798,7 @@ <h4 class="name" id="getMTU">
17981798

17991799

18001800
<div class="tag-source">
1801-
network.js, line 2706
1801+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2706">line 2706</a>
18021802
</div>
18031803

18041804
</div>
@@ -1898,7 +1898,7 @@ <h4 class="name" id="getName">
18981898

18991899

19001900
<div class="tag-source">
1901-
network.js, line 2684
1901+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2684">line 2684</a>
19021902
</div>
19031903

19041904
</div>
@@ -1998,7 +1998,7 @@ <h4 class="name" id="getNetwork">
19981998

19991999

20002000
<div class="tag-source">
2001-
network.js, line 2963
2001+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2963">line 2963</a>
20022002
</div>
20032003

20042004
</div>
@@ -2103,7 +2103,7 @@ <h4 class="name" id="getNetworks">
21032103

21042104

21052105
<div class="tag-source">
2106-
network.js, line 2974
2106+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2974">line 2974</a>
21072107
</div>
21082108

21092109
</div>
@@ -2204,7 +2204,7 @@ <h4 class="name" id="getPorts">
22042204

22052205

22062206
<div class="tag-source">
2207-
network.js, line 2834
2207+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2834">line 2834</a>
22082208
</div>
22092209

22102210
</div>
@@ -2309,7 +2309,7 @@ <h4 class="name" id="getRXBytes">
23092309

23102310

23112311
<div class="tag-source">
2312-
network.js, line 2928
2312+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2928">line 2928</a>
23132313
</div>
23142314

23152315
</div>
@@ -2409,7 +2409,7 @@ <h4 class="name" id="getRXPackets">
24092409

24102410

24112411
<div class="tag-source">
2412-
network.js, line 2950
2412+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2950">line 2950</a>
24132413
</div>
24142414

24152415
</div>
@@ -2509,7 +2509,7 @@ <h4 class="name" id="getShortName">
25092509

25102510

25112511
<div class="tag-source">
2512-
network.js, line 2769
2512+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2769">line 2769</a>
25132513
</div>
25142514

25152515
</div>
@@ -2610,7 +2610,7 @@ <h4 class="name" id="getTXBytes">
26102610

26112611

26122612
<div class="tag-source">
2613-
network.js, line 2917
2613+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2917">line 2917</a>
26142614
</div>
26152615

26162616
</div>
@@ -2710,7 +2710,7 @@ <h4 class="name" id="getTXPackets">
27102710

27112711

27122712
<div class="tag-source">
2713-
network.js, line 2939
2713+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2939">line 2939</a>
27142714
</div>
27152715

27162716
</div>
@@ -2810,7 +2810,7 @@ <h4 class="name" id="getType">
28102810

28112811

28122812
<div class="tag-source">
2813-
network.js, line 2745
2813+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2745">line 2745</a>
28142814
</div>
28152815

28162816
</div>
@@ -2919,7 +2919,7 @@ <h4 class="name" id="getTypeI18n">
29192919

29202920

29212921
<div class="tag-source">
2922-
network.js, line 2801
2922+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2801">line 2801</a>
29232923
</div>
29242924

29252925
</div>
@@ -3020,7 +3020,7 @@ <h4 class="name" id="getWifiNetwork">
30203020

30213021

30223022
<div class="tag-source">
3023-
network.js, line 2998
3023+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2998">line 2998</a>
30243024
</div>
30253025

30263026
</div>
@@ -3125,7 +3125,7 @@ <h4 class="name" id="isBridge">
31253125

31263126

31273127
<div class="tag-source">
3128-
network.js, line 2896
3128+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2896">line 2896</a>
31293129
</div>
31303130

31313131
</div>
@@ -3226,7 +3226,7 @@ <h4 class="name" id="isBridgePort">
32263226

32273227

32283228
<div class="tag-source">
3229-
network.js, line 2907
3229+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2907">line 2907</a>
32303230
</div>
32313231

32323232
</div>
@@ -3327,7 +3327,7 @@ <h4 class="name" id="isUp">
33273327

33283328

33293329
<div class="tag-source">
3330-
network.js, line 2880
3330+
<a href="network.js.html">network.js</a>, <a href="network.js.html#line2880">line 2880</a>
33313331
</div>
33323332

33333333
</div>
@@ -3436,7 +3436,7 @@ <h5>Returns:</h5>
34363436

34373437

34383438
<footer>
3439-
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)
3439+
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)
34403440
</footer>
34413441
</div>
34423442
</div>

0 commit comments

Comments
 (0)