Skip to content

Commit 6fe5ce1

Browse files
committed
(#40) Typedoc update
1 parent f986636 commit 6fe5ce1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+2395
-3713
lines changed

docs/assets/css/main.css

100755100644
+1,771-1,413
Large diffs are not rendered by default.

docs/assets/images/icons.png

100755100644
File mode changed.

docs/assets/images/[email protected]

100755100644
File mode changed.

docs/assets/images/widgets.png

100755100644
File mode changed.

docs/assets/images/[email protected]

100755100644
File mode changed.

docs/assets/js/main.js

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

docs/assets/js/search.js

-3
This file was deleted.

docs/classes/assert.html

+8-49
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
66
<title>Assert | @nut-tree/nut-js</title>
7-
<meta name="description" content="">
7+
<meta name="description" content="Documentation for @nut-tree/nut-js">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="../assets/css/main.css">
1010
</head>
@@ -13,7 +13,7 @@
1313
<div class="tsd-page-toolbar">
1414
<div class="container">
1515
<div class="table-wrap">
16-
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
16+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
1717
<div class="field">
1818
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
1919
<input id="tsd-search-field" type="text" />
@@ -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/e3df158/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/f986636/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/e3df158/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/f986636/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/e3df158/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/f986636/lib/assert.class.ts#L25">assert.class.ts:25</a></li>
161161
</ul>
162162
</aside>
163163
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -216,57 +216,16 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
216216
<h2>Legend</h2>
217217
<div class="tsd-legend-group">
218218
<ul class="tsd-legend">
219-
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
220-
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
221-
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
222-
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
223-
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
224-
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
225-
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
226-
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
227-
</ul>
228-
<ul class="tsd-legend">
229-
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
230-
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
231-
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
232-
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
233-
</ul>
234-
<ul class="tsd-legend">
235-
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
236-
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
237-
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
238-
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
239-
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
240-
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
241-
</ul>
242-
<ul class="tsd-legend">
243-
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
244-
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
245219
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
246220
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
247221
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
248-
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
249-
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
250222
</ul>
251223
<ul class="tsd-legend">
252-
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
253-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
254-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
255-
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
256-
</ul>
257-
<ul class="tsd-legend">
258-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
259-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
260-
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
261-
</ul>
262-
<ul class="tsd-legend">
263-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
264-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
265-
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
224+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
225+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
266226
</ul>
267227
<ul class="tsd-legend">
268-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
269-
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
228+
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
270229
</ul>
271230
</div>
272231
</div>

docs/classes/bresenham.html

+6-47
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
66
<title>Bresenham | @nut-tree/nut-js</title>
7-
<meta name="description" content="">
7+
<meta name="description" content="Documentation for @nut-tree/nut-js">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="../assets/css/main.css">
1010
</head>
@@ -13,7 +13,7 @@
1313
<div class="tsd-page-toolbar">
1414
<div class="container">
1515
<div class="table-wrap">
16-
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
16+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
1717
<div class="field">
1818
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
1919
<input id="tsd-search-field" type="text" />
@@ -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/e3df158/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/f986636/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>
@@ -145,57 +145,16 @@ <h4 class="tsd-returns-title">Returns <a href="point.html" class="tsd-signature-
145145
<h2>Legend</h2>
146146
<div class="tsd-legend-group">
147147
<ul class="tsd-legend">
148-
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
149-
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
150-
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
151-
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
152-
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
153-
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
154-
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
155-
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
156-
</ul>
157-
<ul class="tsd-legend">
158-
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
159-
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
160-
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
161-
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
162-
</ul>
163-
<ul class="tsd-legend">
164-
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
165-
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
166-
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
167-
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
168-
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
169-
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
170-
</ul>
171-
<ul class="tsd-legend">
172-
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
173-
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
174148
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
175149
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
176150
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
177-
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
178-
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
179151
</ul>
180152
<ul class="tsd-legend">
181-
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
182-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
183-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
184-
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
185-
</ul>
186-
<ul class="tsd-legend">
187-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
188-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
189-
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
190-
</ul>
191-
<ul class="tsd-legend">
192-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
193-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
194-
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
153+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
154+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
195155
</ul>
196156
<ul class="tsd-legend">
197-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
198-
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
157+
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
199158
</ul>
200159
</div>
201160
</div>

0 commit comments

Comments
 (0)