Skip to content

Commit 7632947

Browse files
s1hofmanns1hofmann
committed
(#87) Generated API docs
1 parent f6d8c6b commit 7632947

38 files changed

+324
-424
lines changed

‎docs/assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/assert.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ <h3>constructor</h3>
104104
<li class="tsd-description">
105105
<aside class="tsd-sources">
106106
<ul>
107-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/assert.class.ts#L5">assert.class.ts:5</a></li>
107+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/assert.class.ts#L5">assert.class.ts:5</a></li>
108108
</ul>
109109
</aside>
110110
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -130,7 +130,7 @@ <h3>is<wbr>Visible</h3>
130130
<li class="tsd-description">
131131
<aside class="tsd-sources">
132132
<ul>
133-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/assert.class.ts#L8">assert.class.ts:8</a></li>
133+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/assert.class.ts#L8">assert.class.ts:8</a></li>
134134
</ul>
135135
</aside>
136136
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -159,7 +159,7 @@ <h3>not<wbr>Visible</h3>
159159
<li class="tsd-description">
160160
<aside class="tsd-sources">
161161
<ul>
162-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/assert.class.ts#L25">assert.class.ts:25</a></li>
162+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/assert.class.ts#L25">assert.class.ts:25</a></li>
163163
</ul>
164164
</aside>
165165
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/classes/bresenham.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> compute</h3>
9797
<li class="tsd-description">
9898
<aside class="tsd-sources">
9999
<ul>
100-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/util/bresenham.class.ts#L4">util/bresenham.class.ts:4</a></li>
100+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/util/bresenham.class.ts#L4">util/bresenham.class.ts:4</a></li>
101101
</ul>
102102
</aside>
103103
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/classes/clipboard.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ <h3>constructor</h3>
104104
<li class="tsd-description">
105105
<aside class="tsd-sources">
106106
<ul>
107-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/clipboard.class.ts#L3">clipboard.class.ts:3</a></li>
107+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/clipboard.class.ts#L3">clipboard.class.ts:3</a></li>
108108
</ul>
109109
</aside>
110110
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -130,7 +130,7 @@ <h3>copy</h3>
130130
<li class="tsd-description">
131131
<aside class="tsd-sources">
132132
<ul>
133-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/clipboard.class.ts#L7">clipboard.class.ts:7</a></li>
133+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/clipboard.class.ts#L7">clipboard.class.ts:7</a></li>
134134
</ul>
135135
</aside>
136136
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -153,7 +153,7 @@ <h3>paste</h3>
153153
<li class="tsd-description">
154154
<aside class="tsd-sources">
155155
<ul>
156-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/clipboard.class.ts#L11">clipboard.class.ts:11</a></li>
156+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/clipboard.class.ts#L11">clipboard.class.ts:11</a></li>
157157
</ul>
158158
</aside>
159159
<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/clipboardaction.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ <h3>constructor</h3>
112112
<li class="tsd-description">
113113
<aside class="tsd-sources">
114114
<ul>
115-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/provider/native/clipboardy-clipboard-action.class.ts#L4">provider/native/clipboardy-clipboard-action.class.ts:4</a></li>
115+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/provider/native/clipboardy-clipboard-action.class.ts#L4">provider/native/clipboardy-clipboard-action.class.ts:4</a></li>
116116
</ul>
117117
</aside>
118118
<h4 class="tsd-returns-title">Returns <a href="clipboardaction.html" class="tsd-signature-type">ClipboardAction</a></h4>
@@ -133,7 +133,7 @@ <h3>clear</h3>
133133
<aside class="tsd-sources">
134134
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#clear">clear</a></p>
135135
<ul>
136-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/provider/native/clipboardy-clipboard-action.class.ts#L19">provider/native/clipboardy-clipboard-action.class.ts:19</a></li>
136+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/provider/native/clipboardy-clipboard-action.class.ts#L19">provider/native/clipboardy-clipboard-action.class.ts:19</a></li>
137137
</ul>
138138
</aside>
139139
<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>
@@ -151,7 +151,7 @@ <h3>copy</h3>
151151
<aside class="tsd-sources">
152152
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#copy">copy</a></p>
153153
<ul>
154-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/provider/native/clipboardy-clipboard-action.class.ts#L23">provider/native/clipboardy-clipboard-action.class.ts:23</a></li>
154+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/provider/native/clipboardy-clipboard-action.class.ts#L23">provider/native/clipboardy-clipboard-action.class.ts:23</a></li>
155155
</ul>
156156
</aside>
157157
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -175,7 +175,7 @@ <h3>has<wbr>Text</h3>
175175
<aside class="tsd-sources">
176176
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#hastext">hasText</a></p>
177177
<ul>
178-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/provider/native/clipboardy-clipboard-action.class.ts#L8">provider/native/clipboardy-clipboard-action.class.ts:8</a></li>
178+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/provider/native/clipboardy-clipboard-action.class.ts#L8">provider/native/clipboardy-clipboard-action.class.ts:8</a></li>
179179
</ul>
180180
</aside>
181181
<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>
@@ -193,7 +193,7 @@ <h3>paste</h3>
193193
<aside class="tsd-sources">
194194
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#paste">paste</a></p>
195195
<ul>
196-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/provider/native/clipboardy-clipboard-action.class.ts#L34">provider/native/clipboardy-clipboard-action.class.ts:34</a></li>
196+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/provider/native/clipboardy-clipboard-action.class.ts#L34">provider/native/clipboardy-clipboard-action.class.ts:34</a></li>
197197
</ul>
198198
</aside>
199199
<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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ <h3>constructor</h3>
113113
<li class="tsd-description">
114114
<aside class="tsd-sources">
115115
<ul>
116-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/image.class.ts#L1">image.class.ts:1</a></li>
116+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/image.class.ts#L1">image.class.ts:1</a></li>
117117
</ul>
118118
</aside>
119119
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -155,7 +155,7 @@ <h3>channels</h3>
155155
<div class="tsd-signature tsd-kind-icon">channels<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
156156
<aside class="tsd-sources">
157157
<ul>
158-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/image.class.ts#L6">image.class.ts:6</a></li>
158+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/image.class.ts#L6">image.class.ts:6</a></li>
159159
</ul>
160160
</aside>
161161
</section>
@@ -165,7 +165,7 @@ <h3>data</h3>
165165
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
166166
<aside class="tsd-sources">
167167
<ul>
168-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/image.class.ts#L5">image.class.ts:5</a></li>
168+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/image.class.ts#L5">image.class.ts:5</a></li>
169169
</ul>
170170
</aside>
171171
</section>
@@ -175,7 +175,7 @@ <h3>height</h3>
175175
<div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
176176
<aside class="tsd-sources">
177177
<ul>
178-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/image.class.ts#L4">image.class.ts:4</a></li>
178+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/image.class.ts#L4">image.class.ts:4</a></li>
179179
</ul>
180180
</aside>
181181
</section>
@@ -185,7 +185,7 @@ <h3>pixel<wbr>Density</h3>
185185
<div class="tsd-signature tsd-kind-icon">pixel<wbr>Density<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
186186
<aside class="tsd-sources">
187187
<ul>
188-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/image.class.ts#L7">image.class.ts:7</a></li>
188+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/image.class.ts#L7">image.class.ts:7</a></li>
189189
</ul>
190190
</aside>
191191
<div class="tsd-type-declaration">
@@ -206,7 +206,7 @@ <h3>width</h3>
206206
<div class="tsd-signature tsd-kind-icon">width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
207207
<aside class="tsd-sources">
208208
<ul>
209-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/image.class.ts#L3">image.class.ts:3</a></li>
209+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/image.class.ts#L3">image.class.ts:3</a></li>
210210
</ul>
211211
</aside>
212212
</section>
@@ -223,7 +223,7 @@ <h3>has<wbr>Alpha<wbr>Channel</h3>
223223
<li class="tsd-description">
224224
<aside class="tsd-sources">
225225
<ul>
226-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/image.class.ts#L17">image.class.ts:17</a></li>
226+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/image.class.ts#L17">image.class.ts:17</a></li>
227227
</ul>
228228
</aside>
229229
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>

‎docs/classes/imageprocessor.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Image<wbr>With<w
9898
<li class="tsd-description">
9999
<aside class="tsd-sources">
100100
<ul>
101-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/provider/opencv/image-processor.class.ts#L23">provider/opencv/image-processor.class.ts:23</a></li>
101+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/provider/opencv/image-processor.class.ts#L23">provider/opencv/image-processor.class.ts:23</a></li>
102102
</ul>
103103
</aside>
104104
<div class="tsd-comment tsd-typography">
@@ -139,7 +139,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from<wbr>Image<wbr>Withou
139139
<li class="tsd-description">
140140
<aside class="tsd-sources">
141141
<ul>
142-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/provider/opencv/image-processor.class.ts#L44">provider/opencv/image-processor.class.ts:44</a></li>
142+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/provider/opencv/image-processor.class.ts#L44">provider/opencv/image-processor.class.ts:44</a></li>
143143
</ul>
144144
</aside>
145145
<div class="tsd-comment tsd-typography">

‎docs/classes/imagereader.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ <h3>load</h3>
104104
<aside class="tsd-sources">
105105
<p>Implementation of <a href="../interfaces/datasource.html">DataSource</a>.<a href="../interfaces/datasource.html#load">load</a></p>
106106
<ul>
107-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/provider/opencv/image-reader.class.ts#L6">provider/opencv/image-reader.class.ts:6</a></li>
107+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/provider/opencv/image-reader.class.ts#L6">provider/opencv/image-reader.class.ts:6</a></li>
108108
</ul>
109109
</aside>
110110
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/classes/imagewriter.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ <h3>store</h3>
103103
<li class="tsd-description">
104104
<aside class="tsd-sources">
105105
<ul>
106-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/provider/opencv/image-writer.class.ts#L7">provider/opencv/image-writer.class.ts:7</a></li>
106+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/provider/opencv/image-writer.class.ts#L7">provider/opencv/image-writer.class.ts:7</a></li>
107107
</ul>
108108
</aside>
109109
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/classes/keyboard.html

Lines changed: 6 additions & 6 deletions
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/f1c6e47/lib/keyboard.class.ts#L24">keyboard.class.ts:24</a></li>
121+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/keyboard.class.ts#L24">keyboard.class.ts:24</a></li>
122122
</ul>
123123
</aside>
124124
<div class="tsd-comment tsd-typography">
@@ -154,7 +154,7 @@ <h3>press<wbr>Key</h3>
154154
<li class="tsd-description">
155155
<aside class="tsd-sources">
156156
<ul>
157-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/keyboard.class.ts#L67">keyboard.class.ts:67</a></li>
157+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/keyboard.class.ts#L67">keyboard.class.ts:67</a></li>
158158
</ul>
159159
</aside>
160160
<div class="tsd-comment tsd-typography">
@@ -192,7 +192,7 @@ <h3>release<wbr>Key</h3>
192192
<li class="tsd-description">
193193
<aside class="tsd-sources">
194194
<ul>
195-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/keyboard.class.ts#L89">keyboard.class.ts:89</a></li>
195+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/keyboard.class.ts#L89">keyboard.class.ts:89</a></li>
196196
</ul>
197197
</aside>
198198
<div class="tsd-comment tsd-typography">
@@ -230,7 +230,7 @@ <h3>type</h3>
230230
<li class="tsd-description">
231231
<aside class="tsd-sources">
232232
<ul>
233-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/keyboard.class.ts#L38">keyboard.class.ts:38</a></li>
233+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/keyboard.class.ts#L38">keyboard.class.ts:38</a></li>
234234
</ul>
235235
</aside>
236236
<div class="tsd-comment tsd-typography">
@@ -260,7 +260,7 @@ <h3>config</h3>
260260
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
261261
<aside class="tsd-sources">
262262
<ul>
263-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/keyboard.class.ts#L19">keyboard.class.ts:19</a></li>
263+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/keyboard.class.ts#L19">keyboard.class.ts:19</a></li>
264264
</ul>
265265
</aside>
266266
<div class="tsd-comment tsd-typography">
@@ -274,7 +274,7 @@ <h3>auto<wbr>Delay<wbr>Ms</h3>
274274
<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"> =&nbsp;300</span></div>
275275
<aside class="tsd-sources">
276276
<ul>
277-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/keyboard.class.ts#L23">keyboard.class.ts:23</a></li>
277+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/fa788ce/lib/keyboard.class.ts#L23">keyboard.class.ts:23</a></li>
278278
</ul>
279279
</aside>
280280
<div class="tsd-comment tsd-typography">

0 commit comments

Comments
 (0)