OpenWrt
/
luci
mirror of https://git.openwrt.org/project/luci.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: add dummy jsdocs README 

Signed-off-by: Jo-Philipp Wich <jo@mein.io>
This commit is contained in:
Jo-Philipp Wich 2019-11-05 16:32:21 +01:00
parent 937a51859d
commit 66fc653b09
22 changed files with 28 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/jsapi/LuCI.Class.html
View File

@ -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>

2
docs/jsapi/LuCI.Headers.html
View File

@ -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>

2
docs/jsapi/LuCI.Network.Device.html
View File

@ -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>

2
docs/jsapi/LuCI.Network.Hosts.html
View File

@ -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>

2
docs/jsapi/LuCI.Network.Protocol.html
View File

@ -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>

2
docs/jsapi/LuCI.Network.WifiDevice.html
View File

@ -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>

2
docs/jsapi/LuCI.Network.WifiNetwork.html
View File

@ -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>

2
docs/jsapi/LuCI.Network.html
View File

@ -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>

2
docs/jsapi/LuCI.Poll.html
View File

@ -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>

2
docs/jsapi/LuCI.Request.html
View File

@ -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>

2
docs/jsapi/LuCI.Request.poll.html
View File

@ -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>

2
docs/jsapi/LuCI.Response.html
View File

@ -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>

2
docs/jsapi/LuCI.XHR.html
View File

@ -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>

2
docs/jsapi/LuCI.dom.html
View File

@ -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>

2
docs/jsapi/LuCI.fs.html
View File

@ -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>

2
docs/jsapi/LuCI.html
View File

@ -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>

2
docs/jsapi/LuCI.rpc.html
View File

@ -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>

2
docs/jsapi/LuCI.uci.html
View File

@ -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>

2
docs/jsapi/LuCI.view.html
View File

@ -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>

4
docs/jsapi/README.md Normal file
View File

@ -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).

31
docs/jsapi/index.html
View File

@ -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 &quot;luci&quot;-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>

2
jsdoc.conf.json
View File

@ -17,6 +17,6 @@
"opts": {
"destination": "docs/jsapi",
"recurse": true,
"readme": "README.md"
"readme": "docs/jsapi/README.md"
}
}