Skip to content

Commit f986636

Browse files
s1hofmanns1hofmann
committed
(#40) Docs update
1 parent e3df158 commit f986636

39 files changed

+560
-337
lines changed

‎docs/assets/js/search.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/assert.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h3>constructor</h3>
102102
<li class="tsd-description">
103103
<aside class="tsd-sources">
104104
<ul>
105-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/assert.class.ts#L5">assert.class.ts:5</a></li>
105+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/assert.class.ts#L5">assert.class.ts:5</a></li>
106106
</ul>
107107
</aside>
108108
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -128,7 +128,7 @@ <h3>is<wbr>Visible</h3>
128128
<li class="tsd-description">
129129
<aside class="tsd-sources">
130130
<ul>
131-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/assert.class.ts#L8">assert.class.ts:8</a></li>
131+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/assert.class.ts#L8">assert.class.ts:8</a></li>
132132
</ul>
133133
</aside>
134134
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -157,7 +157,7 @@ <h3>not<wbr>Visible</h3>
157157
<li class="tsd-description">
158158
<aside class="tsd-sources">
159159
<ul>
160-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/assert.class.ts#L25">assert.class.ts:25</a></li>
160+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/assert.class.ts#L25">assert.class.ts:25</a></li>
161161
</ul>
162162
</aside>
163163
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/classes/bresenham.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> compute</h3>
9595
<li class="tsd-description">
9696
<aside class="tsd-sources">
9797
<ul>
98-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/util/bresenham.class.ts#L4">util/bresenham.class.ts:4</a></li>
98+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/util/bresenham.class.ts#L4">util/bresenham.class.ts:4</a></li>
9999
</ul>
100100
</aside>
101101
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/classes/clipboard.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ <h3>constructor</h3>
109109
<li class="tsd-description">
110110
<aside class="tsd-sources">
111111
<ul>
112-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/clipboard.class.ts#L6">clipboard.class.ts:6</a></li>
112+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/clipboard.class.ts#L6">clipboard.class.ts:6</a></li>
113113
</ul>
114114
</aside>
115115
<div class="tsd-comment tsd-typography">
@@ -145,7 +145,7 @@ <h3>copy</h3>
145145
<li class="tsd-description">
146146
<aside class="tsd-sources">
147147
<ul>
148-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/clipboard.class.ts#L18">clipboard.class.ts:18</a></li>
148+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/clipboard.class.ts#L18">clipboard.class.ts:18</a></li>
149149
</ul>
150150
</aside>
151151
<div class="tsd-comment tsd-typography">
@@ -176,7 +176,7 @@ <h3>paste</h3>
176176
<li class="tsd-description">
177177
<aside class="tsd-sources">
178178
<ul>
179-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/clipboard.class.ts#L25">clipboard.class.ts:25</a></li>
179+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/clipboard.class.ts#L25">clipboard.class.ts:25</a></li>
180180
</ul>
181181
</aside>
182182
<div class="tsd-comment tsd-typography">

‎docs/classes/clipboardaction.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ <h3>constructor</h3>
110110
<li class="tsd-description">
111111
<aside class="tsd-sources">
112112
<ul>
113-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/provider/native/clipboardy-clipboard-action.class.ts#L4">provider/native/clipboardy-clipboard-action.class.ts:4</a></li>
113+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/provider/native/clipboardy-clipboard-action.class.ts#L4">provider/native/clipboardy-clipboard-action.class.ts:4</a></li>
114114
</ul>
115115
</aside>
116116
<h4 class="tsd-returns-title">Returns <a href="clipboardaction.html" class="tsd-signature-type">ClipboardAction</a></h4>
@@ -131,7 +131,7 @@ <h3>clear</h3>
131131
<aside class="tsd-sources">
132132
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#clear">clear</a></p>
133133
<ul>
134-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/provider/native/clipboardy-clipboard-action.class.ts#L19">provider/native/clipboardy-clipboard-action.class.ts:19</a></li>
134+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/provider/native/clipboardy-clipboard-action.class.ts#L19">provider/native/clipboardy-clipboard-action.class.ts:19</a></li>
135135
</ul>
136136
</aside>
137137
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -149,7 +149,7 @@ <h3>copy</h3>
149149
<aside class="tsd-sources">
150150
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#copy">copy</a></p>
151151
<ul>
152-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/provider/native/clipboardy-clipboard-action.class.ts#L23">provider/native/clipboardy-clipboard-action.class.ts:23</a></li>
152+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/provider/native/clipboardy-clipboard-action.class.ts#L23">provider/native/clipboardy-clipboard-action.class.ts:23</a></li>
153153
</ul>
154154
</aside>
155155
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -173,7 +173,7 @@ <h3>has<wbr>Text</h3>
173173
<aside class="tsd-sources">
174174
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#hastext">hasText</a></p>
175175
<ul>
176-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/provider/native/clipboardy-clipboard-action.class.ts#L8">provider/native/clipboardy-clipboard-action.class.ts:8</a></li>
176+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/provider/native/clipboardy-clipboard-action.class.ts#L8">provider/native/clipboardy-clipboard-action.class.ts:8</a></li>
177177
</ul>
178178
</aside>
179179
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -191,7 +191,7 @@ <h3>paste</h3>
191191
<aside class="tsd-sources">
192192
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#paste">paste</a></p>
193193
<ul>
194-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/provider/native/clipboardy-clipboard-action.class.ts#L34">provider/native/clipboardy-clipboard-action.class.ts:34</a></li>
194+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/provider/native/clipboardy-clipboard-action.class.ts#L34">provider/native/clipboardy-clipboard-action.class.ts:34</a></li>
195195
</ul>
196196
</aside>
197197
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>

‎docs/classes/image.html

+7-7
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h3>constructor</h3>
118118
<li class="tsd-description">
119119
<aside class="tsd-sources">
120120
<ul>
121-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/image.class.ts#L4">image.class.ts:4</a></li>
121+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/image.class.ts#L4">image.class.ts:4</a></li>
122122
</ul>
123123
</aside>
124124
<div class="tsd-comment tsd-typography">
@@ -190,7 +190,7 @@ <h3>channels</h3>
190190
<div class="tsd-signature tsd-kind-icon">channels<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
191191
<aside class="tsd-sources">
192192
<ul>
193-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/image.class.ts#L17">image.class.ts:17</a></li>
193+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/image.class.ts#L17">image.class.ts:17</a></li>
194194
</ul>
195195
</aside>
196196
<div class="tsd-comment tsd-typography">
@@ -205,7 +205,7 @@ <h3>data</h3>
205205
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
206206
<aside class="tsd-sources">
207207
<ul>
208-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/image.class.ts#L16">image.class.ts:16</a></li>
208+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/image.class.ts#L16">image.class.ts:16</a></li>
209209
</ul>
210210
</aside>
211211
<div class="tsd-comment tsd-typography">
@@ -220,7 +220,7 @@ <h3>height</h3>
220220
<div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
221221
<aside class="tsd-sources">
222222
<ul>
223-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/image.class.ts#L15">image.class.ts:15</a></li>
223+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/image.class.ts#L15">image.class.ts:15</a></li>
224224
</ul>
225225
</aside>
226226
<div class="tsd-comment tsd-typography">
@@ -235,7 +235,7 @@ <h3>pixel<wbr>Density</h3>
235235
<div class="tsd-signature tsd-kind-icon">pixel<wbr>Density<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>scaleX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>scaleY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
236236
<aside class="tsd-sources">
237237
<ul>
238-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/image.class.ts#L18">image.class.ts:18</a></li>
238+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/image.class.ts#L18">image.class.ts:18</a></li>
239239
</ul>
240240
</aside>
241241
<div class="tsd-comment tsd-typography">
@@ -261,7 +261,7 @@ <h3>width</h3>
261261
<div class="tsd-signature tsd-kind-icon">width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
262262
<aside class="tsd-sources">
263263
<ul>
264-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/image.class.ts#L14">image.class.ts:14</a></li>
264+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/image.class.ts#L14">image.class.ts:14</a></li>
265265
</ul>
266266
</aside>
267267
<div class="tsd-comment tsd-typography">
@@ -283,7 +283,7 @@ <h3>has<wbr>Alpha<wbr>Channel</h3>
283283
<li class="tsd-description">
284284
<aside class="tsd-sources">
285285
<ul>
286-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/image.class.ts#L31">image.class.ts:31</a></li>
286+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/image.class.ts#L31">image.class.ts:31</a></li>
287287
</ul>
288288
</aside>
289289
<div class="tsd-comment tsd-typography">

‎docs/classes/imageprocessor.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Image<wbr>With<w
9696
<li class="tsd-description">
9797
<aside class="tsd-sources">
9898
<ul>
99-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/provider/opencv/image-processor.class.ts#L23">provider/opencv/image-processor.class.ts:23</a></li>
99+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/provider/opencv/image-processor.class.ts#L23">provider/opencv/image-processor.class.ts:23</a></li>
100100
</ul>
101101
</aside>
102102
<div class="tsd-comment tsd-typography">
@@ -137,7 +137,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Image<wbr>Withou
137137
<li class="tsd-description">
138138
<aside class="tsd-sources">
139139
<ul>
140-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/provider/opencv/image-processor.class.ts#L44">provider/opencv/image-processor.class.ts:44</a></li>
140+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/provider/opencv/image-processor.class.ts#L44">provider/opencv/image-processor.class.ts:44</a></li>
141141
</ul>
142142
</aside>
143143
<div class="tsd-comment tsd-typography">

‎docs/classes/imagereader.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h3>load</h3>
102102
<aside class="tsd-sources">
103103
<p>Implementation of <a href="../interfaces/datasource.html">DataSource</a>.<a href="../interfaces/datasource.html#load">load</a></p>
104104
<ul>
105-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/provider/opencv/image-reader.class.ts#L6">provider/opencv/image-reader.class.ts:6</a></li>
105+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/provider/opencv/image-reader.class.ts#L6">provider/opencv/image-reader.class.ts:6</a></li>
106106
</ul>
107107
</aside>
108108
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/classes/imagewriter.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ <h3>store</h3>
101101
<li class="tsd-description">
102102
<aside class="tsd-sources">
103103
<ul>
104-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/provider/opencv/image-writer.class.ts#L7">provider/opencv/image-writer.class.ts:7</a></li>
104+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/provider/opencv/image-writer.class.ts#L7">provider/opencv/image-writer.class.ts:7</a></li>
105105
</ul>
106106
</aside>
107107
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/classes/keyboard.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ <h3>constructor</h3>
116116
<li class="tsd-description">
117117
<aside class="tsd-sources">
118118
<ul>
119-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/keyboard.class.ts#L24">keyboard.class.ts:24</a></li>
119+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/keyboard.class.ts#L24">keyboard.class.ts:24</a></li>
120120
</ul>
121121
</aside>
122122
<div class="tsd-comment tsd-typography">
@@ -152,7 +152,7 @@ <h3>press<wbr>Key</h3>
152152
<li class="tsd-description">
153153
<aside class="tsd-sources">
154154
<ul>
155-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/keyboard.class.ts#L73">keyboard.class.ts:73</a></li>
155+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/keyboard.class.ts#L73">keyboard.class.ts:73</a></li>
156156
</ul>
157157
</aside>
158158
<div class="tsd-comment tsd-typography">
@@ -190,7 +190,7 @@ <h3>release<wbr>Key</h3>
190190
<li class="tsd-description">
191191
<aside class="tsd-sources">
192192
<ul>
193-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/keyboard.class.ts#L95">keyboard.class.ts:95</a></li>
193+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/keyboard.class.ts#L95">keyboard.class.ts:95</a></li>
194194
</ul>
195195
</aside>
196196
<div class="tsd-comment tsd-typography">
@@ -228,7 +228,7 @@ <h3>type</h3>
228228
<li class="tsd-description">
229229
<aside class="tsd-sources">
230230
<ul>
231-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/keyboard.class.ts#L44">keyboard.class.ts:44</a></li>
231+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/keyboard.class.ts#L44">keyboard.class.ts:44</a></li>
232232
</ul>
233233
</aside>
234234
<div class="tsd-comment tsd-typography">
@@ -264,7 +264,7 @@ <h3>config</h3>
264264
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
265265
<aside class="tsd-sources">
266266
<ul>
267-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/keyboard.class.ts#L19">keyboard.class.ts:19</a></li>
267+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/keyboard.class.ts#L19">keyboard.class.ts:19</a></li>
268268
</ul>
269269
</aside>
270270
<div class="tsd-comment tsd-typography">
@@ -278,7 +278,7 @@ <h3>auto<wbr>Delay<wbr>Ms</h3>
278278
<div class="tsd-signature tsd-kind-icon">auto<wbr>Delay<wbr>Ms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 300</span></div>
279279
<aside class="tsd-sources">
280280
<ul>
281-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/a26192e/lib/keyboard.class.ts#L23">keyboard.class.ts:23</a></li>
281+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e3df158/lib/keyboard.class.ts#L23">keyboard.class.ts:23</a></li>
282282
</ul>
283283
</aside>
284284
<div class="tsd-comment tsd-typography">

0 commit comments

Comments
 (0)