Skip to content

Commit

Permalink
docs(api): update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Christoph Bühler committed Jul 4, 2017
1 parent 3fcea16 commit 2175ff6
Show file tree
Hide file tree
Showing 49 changed files with 412 additions and 433 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/classes/allexport.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AllExport.ts#L10">exports/AllExport.ts:10</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AllExport.ts#L10">exports/AllExport.ts:10</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -159,7 +159,7 @@ <h3>end</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/export.html">Export</a>.<a href="../interfaces/export.html#end">end</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AllExport.ts#L11">exports/AllExport.ts:11</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AllExport.ts#L11">exports/AllExport.ts:11</a></li>
</ul>
</aside>
</section>
Expand All @@ -169,7 +169,7 @@ <h3>from</h3>
<div class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AllExport.ts#L11">exports/AllExport.ts:11</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AllExport.ts#L11">exports/AllExport.ts:11</a></li>
</ul>
</aside>
</section>
Expand All @@ -180,7 +180,7 @@ <h3>start</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/export.html">Export</a>.<a href="../interfaces/export.html#start">start</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AllExport.ts#L11">exports/AllExport.ts:11</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AllExport.ts#L11">exports/AllExport.ts:11</a></li>
</ul>
</aside>
</section>
Expand Down
12 changes: 6 additions & 6 deletions docs/classes/assignedexport.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AssignedExport.ts#L33">exports/AssignedExport.ts:33</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AssignedExport.ts#L33">exports/AssignedExport.ts:33</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -168,7 +168,7 @@ <h3>declaration<wbr>Identifier</h3>
<div class="tsd-signature tsd-kind-icon">declaration<wbr>Identifier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AssignedExport.ts#L38">exports/AssignedExport.ts:38</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AssignedExport.ts#L38">exports/AssignedExport.ts:38</a></li>
</ul>
</aside>
</section>
Expand All @@ -179,7 +179,7 @@ <h3>end</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/export.html">Export</a>.<a href="../interfaces/export.html#end">end</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AssignedExport.ts#L37">exports/AssignedExport.ts:37</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AssignedExport.ts#L37">exports/AssignedExport.ts:37</a></li>
</ul>
</aside>
</section>
Expand All @@ -189,7 +189,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> resource</h3>
<div class="tsd-signature tsd-kind-icon">resource<span class="tsd-signature-symbol">:</span> <a href="../interfaces/resource.html" class="tsd-signature-type">Resource</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AssignedExport.ts#L39">exports/AssignedExport.ts:39</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AssignedExport.ts#L39">exports/AssignedExport.ts:39</a></li>
</ul>
</aside>
</section>
Expand All @@ -200,7 +200,7 @@ <h3>start</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/export.html">Export</a>.<a href="../interfaces/export.html#start">start</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AssignedExport.ts#L36">exports/AssignedExport.ts:36</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AssignedExport.ts#L36">exports/AssignedExport.ts:36</a></li>
</ul>
</aside>
</section>
Expand All @@ -217,7 +217,7 @@ <h3>exported</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/exports/AssignedExport.ts#L24">exports/AssignedExport.ts:24</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/exports/AssignedExport.ts#L24">exports/AssignedExport.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
18 changes: 9 additions & 9 deletions docs/classes/classdeclaration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L19">declarations/ClassDeclaration.ts:19</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L19">declarations/ClassDeclaration.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -174,7 +174,7 @@ <h3>ctor</h3>
<div class="tsd-signature tsd-kind-icon">ctor<span class="tsd-signature-symbol">:</span> <a href="constructordeclaration.html" class="tsd-signature-type">ConstructorDeclaration</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L16">declarations/ClassDeclaration.ts:16</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L16">declarations/ClassDeclaration.ts:16</a></li>
</ul>
</aside>
</section>
Expand All @@ -185,7 +185,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> end</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/genericdeclaration.html">GenericDeclaration</a>.<a href="../interfaces/genericdeclaration.html#end">end</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L25">declarations/ClassDeclaration.ts:25</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L25">declarations/ClassDeclaration.ts:25</a></li>
</ul>
</aside>
</section>
Expand All @@ -196,7 +196,7 @@ <h3>is<wbr>Exported</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/exportabledeclaration.html">ExportableDeclaration</a>.<a href="../interfaces/exportabledeclaration.html#isexported">isExported</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L23">declarations/ClassDeclaration.ts:23</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L23">declarations/ClassDeclaration.ts:23</a></li>
</ul>
</aside>
</section>
Expand All @@ -207,7 +207,7 @@ <h3>methods</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/classlikedeclaration.html">ClassLikeDeclaration</a>.<a href="../interfaces/classlikedeclaration.html#methods">methods</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L18">declarations/ClassDeclaration.ts:18</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L18">declarations/ClassDeclaration.ts:18</a></li>
</ul>
</aside>
</section>
Expand All @@ -218,7 +218,7 @@ <h3>name</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/genericdeclaration.html">GenericDeclaration</a>.<a href="../interfaces/genericdeclaration.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L22">declarations/ClassDeclaration.ts:22</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L22">declarations/ClassDeclaration.ts:22</a></li>
</ul>
</aside>
</section>
Expand All @@ -229,7 +229,7 @@ <h3>properties</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/classlikedeclaration.html">ClassLikeDeclaration</a>.<a href="../interfaces/classlikedeclaration.html#properties">properties</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L17">declarations/ClassDeclaration.ts:17</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L17">declarations/ClassDeclaration.ts:17</a></li>
</ul>
</aside>
</section>
Expand All @@ -240,7 +240,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> start</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/genericdeclaration.html">GenericDeclaration</a>.<a href="../interfaces/genericdeclaration.html#start">start</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L24">declarations/ClassDeclaration.ts:24</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L24">declarations/ClassDeclaration.ts:24</a></li>
</ul>
</aside>
</section>
Expand All @@ -251,7 +251,7 @@ <h3>type<wbr>Parameters</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/genericdeclaration.html">GenericDeclaration</a>.<a href="../interfaces/genericdeclaration.html#typeparameters">typeParameters</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ClassDeclaration.ts#L19">declarations/ClassDeclaration.ts:19</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ClassDeclaration.ts#L19">declarations/ClassDeclaration.ts:19</a></li>
</ul>
</aside>
</section>
Expand Down
12 changes: 6 additions & 6 deletions docs/classes/constructordeclaration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ConstructorDeclaration.ts#L14">declarations/ConstructorDeclaration.ts:14</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ConstructorDeclaration.ts#L14">declarations/ConstructorDeclaration.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -161,7 +161,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> end</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/callabledeclaration.html">CallableDeclaration</a>.<a href="../interfaces/callabledeclaration.html#end">end</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ConstructorDeclaration.ts#L19">declarations/ConstructorDeclaration.ts:19</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ConstructorDeclaration.ts#L19">declarations/ConstructorDeclaration.ts:19</a></li>
</ul>
</aside>
</section>
Expand All @@ -172,7 +172,7 @@ <h3>name</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/callabledeclaration.html">CallableDeclaration</a>.<a href="../interfaces/callabledeclaration.html#name">name</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ConstructorDeclaration.ts#L17">declarations/ConstructorDeclaration.ts:17</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ConstructorDeclaration.ts#L17">declarations/ConstructorDeclaration.ts:17</a></li>
</ul>
</aside>
</section>
Expand All @@ -183,7 +183,7 @@ <h3>parameters</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/callabledeclaration.html">CallableDeclaration</a>.<a href="../interfaces/callabledeclaration.html#parameters">parameters</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ConstructorDeclaration.ts#L13">declarations/ConstructorDeclaration.ts:13</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ConstructorDeclaration.ts#L13">declarations/ConstructorDeclaration.ts:13</a></li>
</ul>
</aside>
</section>
Expand All @@ -194,7 +194,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> start</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/callabledeclaration.html">CallableDeclaration</a>.<a href="../interfaces/callabledeclaration.html#start">start</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ConstructorDeclaration.ts#L18">declarations/ConstructorDeclaration.ts:18</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ConstructorDeclaration.ts#L18">declarations/ConstructorDeclaration.ts:18</a></li>
</ul>
</aside>
</section>
Expand All @@ -205,7 +205,7 @@ <h3>variables</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/callabledeclaration.html">CallableDeclaration</a>.<a href="../interfaces/callabledeclaration.html#variables">variables</a></p>
<ul>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/234d182/src/declarations/ConstructorDeclaration.ts#L14">declarations/ConstructorDeclaration.ts:14</a></li>
<li>Defined in <a href="https://github.com/TypeScript-Heroes/node-typescript-parser/blob/3fcea16/src/declarations/ConstructorDeclaration.ts#L14">declarations/ConstructorDeclaration.ts:14</a></li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit 2175ff6

Please sign in to comment.