Skip to content
This repository has been archived by the owner on Feb 20, 2020. It is now read-only.

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ikatyang committed Aug 1, 2017
1 parent 9efd74b commit 0c8283a
Showing 92 changed files with 2,090 additions and 744 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js

Large diffs are not rendered by default.

90 changes: 45 additions & 45 deletions docs/enums/elementkind.html

Large diffs are not rendered by default.

1,348 changes: 1,268 additions & 80 deletions docs/globals.html

Large diffs are not rendered by default.

145 changes: 137 additions & 8 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>dts-element v2.0.5</title>
<title>dts-element</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
@@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">dts-element v2.0.5</a>
<a href="index.html" class="title">dts-element</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@@ -54,7 +54,7 @@
<a href="globals.html">Globals</a>
</li>
</ul>
<h1> dts-element v2.0.5</h1>
<h1> dts-element</h1>
</div>
</div>
</header>
@@ -142,17 +142,14 @@ <h2 id="development">Development</h2>
<pre><code class="lang-sh"><span class="hljs-comment"># test</span>
yarn run <span class="hljs-built_in">test</span>

<span class="hljs-comment"># test with coverage</span>
yarn run <span class="hljs-built_in">test</span>-coverage

<span class="hljs-comment"># build</span>
yarn run build

<span class="hljs-comment"># lint</span>
yarn run lint

<span class="hljs-comment"># generate documentation</span>
yarn run typedoc
<span class="hljs-comment"># generate docs</span>
yarn run docs
</code></pre>
<h2 id="related">Related</h2>
<ul>
@@ -626,6 +623,138 @@ <h2 id="related">Related</h2>
<li class=" tsd-kind-function">
<a href="globals.html#emit_native" class="tsd-kind-icon">emit_<wbr>native</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_array_type" class="tsd-kind-icon">is_<wbr>array_<wbr>type</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_class_declaration" class="tsd-kind-icon">is_<wbr>class_<wbr>declaration</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_class_member" class="tsd-kind-icon">is_<wbr>class_<wbr>member</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_constructor_type" class="tsd-kind-icon">is_<wbr>constructor_<wbr>type</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_element" class="tsd-kind-icon">is_<wbr>element</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_enum_declaration" class="tsd-kind-icon">is_<wbr>enum_<wbr>declaration</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_export_default" class="tsd-kind-icon">is_<wbr>export_<wbr>default</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_export_equal" class="tsd-kind-icon">is_<wbr>export_<wbr>equal</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_export_member" class="tsd-kind-icon">is_<wbr>export_<wbr>member</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_export_named" class="tsd-kind-icon">is_<wbr>export_<wbr>named</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_export_namespace" class="tsd-kind-icon">is_<wbr>export_<wbr>namespace</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_function_declaration" class="tsd-kind-icon">is_<wbr>function_<wbr>declaration</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_function_type" class="tsd-kind-icon">is_<wbr>function_<wbr>type</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_general_type" class="tsd-kind-icon">is_<wbr>general_<wbr>type</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_generic_declaration" class="tsd-kind-icon">is_<wbr>generic_<wbr>declaration</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_global_declaration" class="tsd-kind-icon">is_<wbr>global_<wbr>declaration</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_import_equal" class="tsd-kind-icon">is_<wbr>import_<wbr>equal</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_import_member" class="tsd-kind-icon">is_<wbr>import_<wbr>member</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_import_named" class="tsd-kind-icon">is_<wbr>import_<wbr>named</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_import_namespace" class="tsd-kind-icon">is_<wbr>import_<wbr>namespace</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_index_signature" class="tsd-kind-icon">is_<wbr>index_<wbr>signature</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_interface_declaration" class="tsd-kind-icon">is_<wbr>interface_<wbr>declaration</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_intersection_type" class="tsd-kind-icon">is_<wbr>intersection_<wbr>type</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_jsdoc_comment" class="tsd-kind-icon">is_<wbr>jsdoc_<wbr>comment</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_keyof_type" class="tsd-kind-icon">is_<wbr>keyof_<wbr>type</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_literal_type" class="tsd-kind-icon">is_<wbr>literal_<wbr>type</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_mapped_type" class="tsd-kind-icon">is_<wbr>mapped_<wbr>type</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_module_declaration" class="tsd-kind-icon">is_<wbr>module_<wbr>declaration</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_multi_line_comment" class="tsd-kind-icon">is_<wbr>multi_<wbr>line_<wbr>comment</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_namespace_declaration" class="tsd-kind-icon">is_<wbr>namespace_<wbr>declaration</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_native_type" class="tsd-kind-icon">is_<wbr>native_<wbr>type</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_object_member" class="tsd-kind-icon">is_<wbr>object_<wbr>member</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_object_type" class="tsd-kind-icon">is_<wbr>object_<wbr>type</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_parameter_declaration" class="tsd-kind-icon">is_<wbr>parameter_<wbr>declaration</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_single_line_comment" class="tsd-kind-icon">is_<wbr>single_<wbr>line_<wbr>comment</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_sub_type" class="tsd-kind-icon">is_<wbr>sub_<wbr>type</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_top_level_element" class="tsd-kind-icon">is_<wbr>top_<wbr>level_<wbr>element</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_triple_slash_reference" class="tsd-kind-icon">is_<wbr>triple_<wbr>slash_<wbr>reference</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_tuple_type" class="tsd-kind-icon">is_<wbr>tuple_<wbr>type</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_type_declaration" class="tsd-kind-icon">is_<wbr>type_<wbr>declaration</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_type_predicate" class="tsd-kind-icon">is_<wbr>type_<wbr>predicate</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_typeof_type" class="tsd-kind-icon">is_<wbr>typeof_<wbr>type</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_union_type" class="tsd-kind-icon">is_<wbr>union_<wbr>type</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#is_variable_declaration" class="tsd-kind-icon">is_<wbr>variable_<wbr>declaration</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#parse" class="tsd-kind-icon">parse</a>
</li>
12 changes: 6 additions & 6 deletions docs/interfaces/iarraytype.html
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IArrayType | dts-element v2.0.5</title>
<title>IArrayType | dts-element</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
@@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">dts-element v2.0.5</a>
<a href="../index.html" class="title">dts-element</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@@ -106,7 +106,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> comments</h3>
<p>Inherited from <a href="ielementoptions.html">IElementOptions</a>.<a href="ielementoptions.html#comments">comments</a></p>
<p>Overrides <a href="ielementoptions.html">IElementOptions</a>.<a href="ielementoptions.html#comments">comments</a></p>
<ul>
<li>Defined in <a href="https://github.com/ikatyang/dts-element/blob/v2.0.5/src/element.ts#L7">element.ts:7</a></li>
<li>Defined in <a href="https://github.com/ikatyang/dts-element/blob/9efd74b/src/element.ts#L7">element.ts:7</a></li>
</ul>
</aside>
</section>
@@ -118,7 +118,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> jsdoc</h3>
<p>Inherited from <a href="ielementoptions.html">IElementOptions</a>.<a href="ielementoptions.html#jsdoc">jsdoc</a></p>
<p>Overrides <a href="ielementoptions.html">IElementOptions</a>.<a href="ielementoptions.html#jsdoc">jsdoc</a></p>
<ul>
<li>Defined in <a href="https://github.com/ikatyang/dts-element/blob/v2.0.5/src/element.ts#L6">element.ts:6</a></li>
<li>Defined in <a href="https://github.com/ikatyang/dts-element/blob/9efd74b/src/element.ts#L6">element.ts:6</a></li>
</ul>
</aside>
</section>
@@ -129,7 +129,7 @@ <h3>kind</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="ielement.html">IElement</a>.<a href="ielement.html#kind">kind</a></p>
<ul>
<li>Defined in <a href="https://github.com/ikatyang/dts-element/blob/v2.0.5/src/element.ts#L11">element.ts:11</a></li>
<li>Defined in <a href="https://github.com/ikatyang/dts-element/blob/9efd74b/src/element.ts#L11">element.ts:11</a></li>
</ul>
</aside>
</section>
@@ -140,7 +140,7 @@ <h3>type</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="iarraytypeoptions.html">IArrayTypeOptions</a>.<a href="iarraytypeoptions.html#type">type</a></p>
<ul>
<li>Defined in <a href="https://github.com/ikatyang/dts-element/blob/v2.0.5/src/types/array-type.ts#L8">types/array-type.ts:8</a></li>
<li>Defined in <a href="https://github.com/ikatyang/dts-element/blob/9efd74b/src/types/array-type.ts#L13">types/array-type.ts:13</a></li>
</ul>
</aside>
</section>
10 changes: 5 additions & 5 deletions docs/interfaces/iarraytypeoptions.html
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IArrayTypeOptions | dts-element v2.0.5</title>
<title>IArrayTypeOptions | dts-element</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
@@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">dts-element v2.0.5</a>
<a href="../index.html" class="title">dts-element</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@@ -106,7 +106,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> comments</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="ielementoptions.html">IElementOptions</a>.<a href="ielementoptions.html#comments">comments</a></p>
<ul>
<li>Defined in <a href="https://github.com/ikatyang/dts-element/blob/v2.0.5/src/element.ts#L7">element.ts:7</a></li>
<li>Defined in <a href="https://github.com/ikatyang/dts-element/blob/9efd74b/src/element.ts#L7">element.ts:7</a></li>
</ul>
</aside>
</section>
@@ -117,7 +117,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> jsdoc</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="ielementoptions.html">IElementOptions</a>.<a href="ielementoptions.html#jsdoc">jsdoc</a></p>
<ul>
<li>Defined in <a href="https://github.com/ikatyang/dts-element/blob/v2.0.5/src/element.ts#L6">element.ts:6</a></li>
<li>Defined in <a href="https://github.com/ikatyang/dts-element/blob/9efd74b/src/element.ts#L6">element.ts:6</a></li>
</ul>
</aside>
</section>
@@ -127,7 +127,7 @@ <h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../globals.html#itype" class="tsd-signature-type">IType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ikatyang/dts-element/blob/v2.0.5/src/types/array-type.ts#L8">types/array-type.ts:8</a></li>
<li>Defined in <a href="https://github.com/ikatyang/dts-element/blob/9efd74b/src/types/array-type.ts#L13">types/array-type.ts:13</a></li>
</ul>
</aside>
</section>
Loading

0 comments on commit 0c8283a

Please sign in to comment.