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]>
tiffany-929 · Nov 7, 2019 · 489fc4b · 489fc4b
1 parent 9933dd6
commit 489fc4b
Show file tree

Hide file tree

Showing 29 changed files with 5,855 additions and 503 deletions.
diff --git a/README.md b/README.md
@@ -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
 

diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,6 @@
+# LuCI Documentation
+
+## API Reference
+
+ - [Client side JavaScript APIs](jsapi/index.html)
+ - [Server side Lua APIs](api/index.html)
diff --git a/docs/jsapi/LuCI.Class.html b/docs/jsapi/LuCI.Class.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 @@ <h4 class="name" id="Class">
 
 
         <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 @@ <h4 class="name" id=".extend">
 
 
         <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 @@ <h4 class="name" id=".instantiate">
 
 
         <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 @@ <h4 class="name" id=".isSubclass">
 
 
         <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 @@ <h4 class="name" id=".singleton">
 
 
         <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 @@ <h4 class="name" id="super">
 
 
         <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 @@ <h4 class="name" id="varargs">
 
 
         <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 @@ <h5>Returns:</h5>
 
 
         <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>

diff --git a/docs/jsapi/LuCI.Headers.html b/docs/jsapi/LuCI.Headers.html
@@ -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 @@ <h4 class="name" id="Headers">
 
 
         <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 @@ <h4 class="name" id="get">
 
 
         <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 @@ <h4 class="name" id="has">
 
 
         <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 @@ <h5>Returns:</h5>
 
 
         <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>

diff --git a/docs/jsapi/LuCI.Network.Device.html b/docs/jsapi/LuCI.Network.Device.html
@@ -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 @@ <h4 class="name" id="Device">
 
 
         <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 @@ <h4 class="name" id="getBridgeID">
 
 
         <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 @@ <h4 class="name" id="getBridgeSTP">
 
 
         <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 @@ <h4 class="name" id="getI18n">
 
 
         <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 @@ <h4 class="name" id="getIP6Addrs">
 
 
         <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 @@ <h4 class="name" id="getIPAddrs">
 
 
         <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 @@ <h4 class="name" id="getMAC">
 
 
         <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 @@ <h4 class="name" id="getMTU">
 
 
         <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 @@ <h4 class="name" id="getName">
 
 
         <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 @@ <h4 class="name" id="getNetwork">
 
 
         <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 @@ <h4 class="name" id="getNetworks">
 
 
         <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 @@ <h4 class="name" id="getPorts">
 
 
         <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 @@ <h4 class="name" id="getRXBytes">
 
 
         <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 @@ <h4 class="name" id="getRXPackets">
 
 
         <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 @@ <h4 class="name" id="getShortName">
 
 
         <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 @@ <h4 class="name" id="getTXBytes">
 
 
         <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 @@ <h4 class="name" id="getTXPackets">
 
 
         <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 @@ <h4 class="name" id="getType">
 
 
         <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 @@ <h4 class="name" id="getTypeI18n">
 
 
         <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 @@ <h4 class="name" id="getWifiNetwork">
 
 
         <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 @@ <h4 class="name" id="isBridge">
 
 
         <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 @@ <h4 class="name" id="isBridgePort">
 
 
         <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 @@ <h4 class="name" id="isUp">
 
 
         <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 @@ <h5>Returns:</h5>
 
 
         <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>