Skip to content

Commit 3bcae92

Browse files
s1hofmanns1hofmann
authored
Merge pull request #108 from nut-tree/feature/87/api_docs
Feature/87/api docs
2 parents 985ecc3 + fe4456e commit 3bcae92

Some content is hidden

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

65 files changed

+1261
-881
lines changed

‎docs/assets/css/main.css‎

Lines changed: 46 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -492,6 +492,8 @@ ul.tsd-descriptions > li > :last-child > :last-child > :last-child {
492492
padding-bottom: 200px; }
493493

494494
.row {
495+
display: -ms-flexbox;
496+
display: flex;
495497
position: relative;
496498
margin: 0 -10px; }
497499
.row:after {
@@ -585,7 +587,7 @@ ul.tsd-descriptions > li > :last-child > :last-child > :last-child {
585587
height: 17px;
586588
margin: 0 3px 2px 0;
587589
background-image: url(../images/icons.png); }
588-
@media (-webkit-min-device-pixel-ratio: 1.5), (min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) {
590+
@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) {
589591
.tsd-kind-icon:before {
590592
background-image: url(../images/icons@2x.png);
591593
background-size: 238px 204px; } }
@@ -1556,7 +1558,6 @@ pre {
15561558
position: fixed !important;
15571559
overflow: auto;
15581560
-webkit-overflow-scrolling: touch;
1559-
overflow-scrolling: touch;
15601561
z-index: 1024;
15611562
top: 0 !important;
15621563
bottom: 0 !important;
@@ -1645,7 +1646,6 @@ html.minimal .tsd-navigation {
16451646
position: fixed !important;
16461647
overflow: auto;
16471648
-webkit-overflow-scrolling: touch;
1648-
overflow-scrolling: touch;
16491649
box-sizing: border-box;
16501650
z-index: 1;
16511651
left: 0;
@@ -1823,11 +1823,6 @@ footer {
18231823
-o-column-count: 2;
18241824
column-count: 2; } }
18251825
.tsd-index-panel ul.tsd-index-list li {
1826-
-webkit-column-break-inside: avoid;
1827-
-moz-column-break-inside: avoid;
1828-
-ms-column-break-inside: avoid;
1829-
-o-column-break-inside: avoid;
1830-
column-break-inside: avoid;
18311826
-webkit-page-break-inside: avoid;
18321827
-moz-page-break-inside: avoid;
18331828
-ms-page-break-inside: avoid;
@@ -1884,7 +1879,7 @@ footer {
18841879
border-bottom: none; }
18851880

18861881
.tsd-navigation {
1887-
padding: 0 0 0 40px; }
1882+
margin: 0 0 0 40px; }
18881883
.tsd-navigation a {
18891884
display: block;
18901885
padding-top: 2px;
@@ -1934,56 +1929,45 @@ footer {
19341929
.tsd-navigation.primary li.globals + li > a {
19351930
padding-top: 20px; }
19361931

1937-
.tsd-navigation.secondary ul {
1938-
transition: opacity 0.2s; }
1939-
.tsd-navigation.secondary ul li a {
1940-
padding-left: 25px; }
1941-
.tsd-navigation.secondary ul li li a {
1942-
padding-left: 45px; }
1943-
.tsd-navigation.secondary ul li li li a {
1944-
padding-left: 65px; }
1945-
.tsd-navigation.secondary ul li li li li a {
1946-
padding-left: 85px; }
1947-
.tsd-navigation.secondary ul li li li li li a {
1948-
padding-left: 105px; }
1949-
.tsd-navigation.secondary ul li li li li li li a {
1950-
padding-left: 125px; }
1951-
.tsd-navigation.secondary ul.current a {
1932+
.tsd-navigation.secondary {
1933+
max-height: calc(100vh - 1rem - 40px);
1934+
overflow: auto;
1935+
position: -webkit-sticky;
1936+
position: sticky;
1937+
top: calc(.5rem + 40px);
1938+
transition: .3s; }
1939+
.tsd-navigation.secondary.tsd-navigation--toolbar-hide {
1940+
max-height: calc(100vh - 1rem);
1941+
top: .5rem; }
1942+
.tsd-navigation.secondary ul {
1943+
transition: opacity 0.2s; }
1944+
.tsd-navigation.secondary ul li a {
1945+
padding-left: 25px; }
1946+
.tsd-navigation.secondary ul li li a {
1947+
padding-left: 45px; }
1948+
.tsd-navigation.secondary ul li li li a {
1949+
padding-left: 65px; }
1950+
.tsd-navigation.secondary ul li li li li a {
1951+
padding-left: 85px; }
1952+
.tsd-navigation.secondary ul li li li li li a {
1953+
padding-left: 105px; }
1954+
.tsd-navigation.secondary ul li li li li li li a {
1955+
padding-left: 125px; }
1956+
.tsd-navigation.secondary ul.current a {
1957+
border-left-color: #eee; }
1958+
.tsd-navigation.secondary li.focus > a,
1959+
.tsd-navigation.secondary ul.current li.focus > a {
1960+
border-left-color: #000; }
1961+
.tsd-navigation.secondary li.current {
1962+
margin-top: 20px;
1963+
margin-bottom: 20px;
19521964
border-left-color: #eee; }
1953-
1954-
.tsd-navigation.secondary li.focus > a,
1955-
.tsd-navigation.secondary ul.current li.focus > a {
1956-
border-left-color: #000; }
1957-
1958-
.tsd-navigation.secondary li.current {
1959-
margin-top: 20px;
1960-
margin-bottom: 20px;
1961-
border-left-color: #eee; }
1962-
.tsd-navigation.secondary li.current > a {
1963-
font-weight: bold; }
1965+
.tsd-navigation.secondary li.current > a {
1966+
font-weight: bold; }
19641967

19651968
@media (min-width: 901px) {
19661969
.menu-sticky-wrap {
1967-
position: static; }
1968-
.no-csspositionsticky .menu-sticky-wrap.sticky {
1969-
position: fixed; }
1970-
.no-csspositionsticky .menu-sticky-wrap.sticky-current {
1971-
position: fixed; }
1972-
.no-csspositionsticky .menu-sticky-wrap.sticky-current ul.before-current,
1973-
.no-csspositionsticky .menu-sticky-wrap.sticky-current ul.after-current {
1974-
opacity: 0; }
1975-
.no-csspositionsticky .menu-sticky-wrap.sticky-bottom {
1976-
position: absolute;
1977-
top: auto !important;
1978-
left: auto !important;
1979-
bottom: 0;
1980-
right: 0; }
1981-
.csspositionsticky .menu-sticky-wrap.sticky {
1982-
position: -webkit-sticky;
1983-
position: sticky; }
1984-
.csspositionsticky .menu-sticky-wrap.sticky-current {
1985-
position: -webkit-sticky;
1986-
position: sticky; } }
1970+
position: static; } }
19871971

19881972
.tsd-panel {
19891973
margin: 20px 0;
@@ -2204,15 +2188,16 @@ ul.tsd-type-parameters {
22042188
padding: 0; }
22052189

22062190
.tsd-page-toolbar {
2207-
position: absolute;
2191+
position: fixed;
22082192
z-index: 1;
22092193
top: 0;
22102194
left: 0;
22112195
width: 100%;
22122196
height: 40px;
22132197
color: #333;
22142198
background: #fff;
2215-
border-bottom: 1px solid #eee; }
2199+
border-bottom: 1px solid #eee;
2200+
transition: transform .3s linear; }
22162201
.tsd-page-toolbar a {
22172202
color: #333;
22182203
text-decoration: none; }
@@ -2232,6 +2217,9 @@ ul.tsd-type-parameters {
22322217
.tsd-page-toolbar .table-cell:first-child {
22332218
width: 100%; }
22342219

2220+
.tsd-page-toolbar--hide {
2221+
transform: translateY(-100%); }
2222+
22352223
.tsd-widget:before, .tsd-select .tsd-select-label:before, .tsd-select .tsd-select-list li:before {
22362224
content: '';
22372225
display: inline-block;
@@ -2242,7 +2230,7 @@ ul.tsd-type-parameters {
22422230
background-repeat: no-repeat;
22432231
text-indent: -1024px;
22442232
vertical-align: bottom; }
2245-
@media (-webkit-min-device-pixel-ratio: 1.5), (min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) {
2233+
@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) {
22462234
.tsd-widget:before, .tsd-select .tsd-select-label:before, .tsd-select .tsd-select-list li:before {
22472235
background-image: url(../images/widgets@2x.png);
22482236
background-size: 320px 40px; } }

‎docs/assets/js/main.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/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 & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@
3838
</div>
3939
<input type="checkbox" id="tsd-filter-inherited" checked />
4040
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41-
<input type="checkbox" id="tsd-filter-only-exported" />
42-
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
4341
</div>
4442
</div>
4543
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
@@ -104,7 +102,7 @@ <h3>constructor</h3>
104102
<li class="tsd-description">
105103
<aside class="tsd-sources">
106104
<ul>
107-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/cc7ee90/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/f086bf3/lib/assert.class.ts#L5">assert.class.ts:5</a></li>
108106
</ul>
109107
</aside>
110108
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -130,7 +128,7 @@ <h3>is<wbr>Visible</h3>
130128
<li class="tsd-description">
131129
<aside class="tsd-sources">
132130
<ul>
133-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/cc7ee90/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/f086bf3/lib/assert.class.ts#L8">assert.class.ts:8</a></li>
134132
</ul>
135133
</aside>
136134
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -159,7 +157,7 @@ <h3>not<wbr>Visible</h3>
159157
<li class="tsd-description">
160158
<aside class="tsd-sources">
161159
<ul>
162-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/cc7ee90/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/f086bf3/lib/assert.class.ts#L25">assert.class.ts:25</a></li>
163161
</ul>
164162
</aside>
165163
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/classes/bresenham.html‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@
3838
</div>
3939
<input type="checkbox" id="tsd-filter-inherited" checked />
4040
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41-
<input type="checkbox" id="tsd-filter-only-exported" />
42-
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
4341
</div>
4442
</div>
4543
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
@@ -97,7 +95,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> compute</h3>
9795
<li class="tsd-description">
9896
<aside class="tsd-sources">
9997
<ul>
100-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/cc7ee90/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/f086bf3/lib/util/bresenham.class.ts#L4">util/bresenham.class.ts:4</a></li>
10199
</ul>
102100
</aside>
103101
<h4 class="tsd-parameters-title">Parameters</h4>

‎docs/classes/clipboard.html‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@
3838
</div>
3939
<input type="checkbox" id="tsd-filter-inherited" checked />
4040
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41-
<input type="checkbox" id="tsd-filter-only-exported" />
42-
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
4341
</div>
4442
</div>
4543
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
@@ -111,7 +109,7 @@ <h3>constructor</h3>
111109
<li class="tsd-description">
112110
<aside class="tsd-sources">
113111
<ul>
114-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/cc7ee90/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/f086bf3/lib/clipboard.class.ts#L6">clipboard.class.ts:6</a></li>
115113
</ul>
116114
</aside>
117115
<div class="tsd-comment tsd-typography">
@@ -125,7 +123,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
125123
<h5>nativeAdapter: <a href="nativeadapter.html" class="tsd-signature-type">NativeAdapter</a></h5>
126124
<div class="tsd-comment tsd-typography">
127125
<div class="lead">
128-
<p>instance used to access OS API</p>
126+
<p><a href="nativeadapter.html">NativeAdapter</a> instance used to access OS API</p>
129127
</div>
130128
</div>
131129
</li>
@@ -147,7 +145,7 @@ <h3>copy</h3>
147145
<li class="tsd-description">
148146
<aside class="tsd-sources">
149147
<ul>
150-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/cc7ee90/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/f086bf3/lib/clipboard.class.ts#L18">clipboard.class.ts:18</a></li>
151149
</ul>
152150
</aside>
153151
<div class="tsd-comment tsd-typography">
@@ -178,7 +176,7 @@ <h3>paste</h3>
178176
<li class="tsd-description">
179177
<aside class="tsd-sources">
180178
<ul>
181-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/cc7ee90/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/f086bf3/lib/clipboard.class.ts#L25">clipboard.class.ts:25</a></li>
182180
</ul>
183181
</aside>
184182
<div class="tsd-comment tsd-typography">

‎docs/classes/clipboardaction.html‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@
3838
</div>
3939
<input type="checkbox" id="tsd-filter-inherited" checked />
4040
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41-
<input type="checkbox" id="tsd-filter-only-exported" />
42-
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
4341
</div>
4442
</div>
4543
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
@@ -112,7 +110,7 @@ <h3>constructor</h3>
112110
<li class="tsd-description">
113111
<aside class="tsd-sources">
114112
<ul>
115-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/cc7ee90/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/f086bf3/lib/provider/native/clipboardy-clipboard-action.class.ts#L4">provider/native/clipboardy-clipboard-action.class.ts:4</a></li>
116114
</ul>
117115
</aside>
118116
<h4 class="tsd-returns-title">Returns <a href="clipboardaction.html" class="tsd-signature-type">ClipboardAction</a></h4>
@@ -133,7 +131,7 @@ <h3>clear</h3>
133131
<aside class="tsd-sources">
134132
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#clear">clear</a></p>
135133
<ul>
136-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/cc7ee90/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/f086bf3/lib/provider/native/clipboardy-clipboard-action.class.ts#L19">provider/native/clipboardy-clipboard-action.class.ts:19</a></li>
137135
</ul>
138136
</aside>
139137
<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 +149,7 @@ <h3>copy</h3>
151149
<aside class="tsd-sources">
152150
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#copy">copy</a></p>
153151
<ul>
154-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/cc7ee90/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/f086bf3/lib/provider/native/clipboardy-clipboard-action.class.ts#L23">provider/native/clipboardy-clipboard-action.class.ts:23</a></li>
155153
</ul>
156154
</aside>
157155
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -175,7 +173,7 @@ <h3>has<wbr>Text</h3>
175173
<aside class="tsd-sources">
176174
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#hastext">hasText</a></p>
177175
<ul>
178-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/cc7ee90/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/f086bf3/lib/provider/native/clipboardy-clipboard-action.class.ts#L8">provider/native/clipboardy-clipboard-action.class.ts:8</a></li>
179177
</ul>
180178
</aside>
181179
<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 +191,7 @@ <h3>paste</h3>
193191
<aside class="tsd-sources">
194192
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#paste">paste</a></p>
195193
<ul>
196-
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/cc7ee90/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/f086bf3/lib/provider/native/clipboardy-clipboard-action.class.ts#L34">provider/native/clipboardy-clipboard-action.class.ts:34</a></li>
197195
</ul>
198196
</aside>
199197
<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>

0 commit comments

Comments
 (0)