Skip to content

Commit c7a0a21

Browse files
ashleydavisashleydavis
committed
First pass at generating API docs.
1 parent 353979a commit c7a0a21

15 files changed

+2408
-134
lines changed

‎docs/api/assets/css/main.css‎

Lines changed: 865 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/api/assets/css/main.css.map‎

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/api/assets/images/icons.png‎

9.26 KB
Loading

‎docs/api/assets/images/[email protected]‎

27.1 KB
Loading

‎docs/api/assets/images/widgets.png‎

480 Bytes
Loading

‎docs/api/assets/images/[email protected]‎

855 Bytes
Loading

‎docs/api/assets/js/main.js‎

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/api/assets/js/search.js‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/api/index.html‎

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
<!doctype html>
2+
<html class="default no-js">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<title>Data-Forge</title>
7+
<meta name="description" content="">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="stylesheet" href="assets/css/main.css">
10+
</head>
11+
<body>
12+
<header>
13+
<div class="tsd-page-toolbar">
14+
<div class="container">
15+
<div class="table-wrap">
16+
<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
17+
<div class="field">
18+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19+
<input id="tsd-search-field" type="text" />
20+
</div>
21+
<ul class="results">
22+
<li class="state loading">Preparing search index...</li>
23+
<li class="state failure">The search index is not available</li>
24+
</ul>
25+
<a href="index.html" class="title">Data-Forge</a>
26+
</div>
27+
<div class="table-cell" id="tsd-widgets">
28+
<div id="tsd-filter">
29+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30+
<div class="tsd-filter-group">
31+
<div class="tsd-select" id="tsd-filter-visibility">
32+
<span class="tsd-select-label">All</span>
33+
<ul class="tsd-select-list">
34+
<li data-value="public">Public</li>
35+
<li data-value="protected">Public/Protected</li>
36+
<li data-value="private" class="selected">All</li>
37+
</ul>
38+
</div>
39+
<input type="checkbox" id="tsd-filter-inherited" checked />
40+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41+
</div>
42+
</div>
43+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
44+
</div>
45+
</div>
46+
</div>
47+
</div>
48+
<div class="tsd-page-title">
49+
<div class="container">
50+
<ul class="tsd-breadcrumb">
51+
<li>
52+
<a href="index.html">Globals</a>
53+
</li>
54+
</ul>
55+
<h1> Data-Forge</h1>
56+
</div>
57+
</div>
58+
</header>
59+
<div class="container container-main">
60+
<div class="row">
61+
<div class="col-8 col-content">
62+
<section class="tsd-panel-group tsd-index-group">
63+
<h2>Index</h2>
64+
<section class="tsd-panel tsd-index-panel">
65+
<div class="tsd-index-content">
66+
<section class="tsd-index-section ">
67+
<h3>Interfaces</h3>
68+
<ul class="tsd-index-list">
69+
<li class="tsd-kind-interface"><a href="interfaces/iasyncfilereader.html" class="tsd-kind-icon">IAsync<wbr>File<wbr>Reader</a></li>
70+
<li class="tsd-kind-interface"><a href="interfaces/icsvserializer.html" class="tsd-kind-icon">ICsv<wbr>Serializer</a></li>
71+
<li class="tsd-kind-interface"><a href="interfaces/ijsonserializer.html" class="tsd-kind-icon">IJson<wbr>Serializer</a></li>
72+
<li class="tsd-kind-interface"><a href="interfaces/isyncfilereader.html" class="tsd-kind-icon">ISync<wbr>File<wbr>Reader</a></li>
73+
</ul>
74+
</section>
75+
</div>
76+
</section>
77+
</section>
78+
</div>
79+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
80+
<nav class="tsd-navigation primary">
81+
<ul>
82+
<li class="globals current ">
83+
<a href="index.html"><em>Globals</em></a>
84+
</li>
85+
</ul>
86+
</nav>
87+
<nav class="tsd-navigation secondary menu-sticky">
88+
<ul class="before-current">
89+
<li class=" tsd-kind-interface">
90+
<a href="interfaces/iasyncfilereader.html" class="tsd-kind-icon">IAsync<wbr>File<wbr>Reader</a>
91+
</li>
92+
<li class=" tsd-kind-interface">
93+
<a href="interfaces/icsvserializer.html" class="tsd-kind-icon">ICsv<wbr>Serializer</a>
94+
</li>
95+
<li class=" tsd-kind-interface">
96+
<a href="interfaces/ijsonserializer.html" class="tsd-kind-icon">IJson<wbr>Serializer</a>
97+
</li>
98+
<li class=" tsd-kind-interface">
99+
<a href="interfaces/isyncfilereader.html" class="tsd-kind-icon">ISync<wbr>File<wbr>Reader</a>
100+
</li>
101+
</ul>
102+
</nav>
103+
</div>
104+
</div>
105+
</div>
106+
<footer class="with-border-bottom">
107+
<div class="container">
108+
<h2>Legend</h2>
109+
<div class="tsd-legend-group">
110+
<ul class="tsd-legend">
111+
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
112+
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
113+
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
114+
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
115+
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
116+
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
117+
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
118+
</ul>
119+
<ul class="tsd-legend">
120+
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
121+
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
122+
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
123+
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
124+
</ul>
125+
<ul class="tsd-legend">
126+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
127+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
128+
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
129+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
130+
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
131+
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
132+
</ul>
133+
<ul class="tsd-legend">
134+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
135+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
136+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
137+
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
138+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
139+
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
140+
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
141+
</ul>
142+
<ul class="tsd-legend">
143+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
144+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
145+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
146+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
147+
</ul>
148+
<ul class="tsd-legend">
149+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
150+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
151+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
152+
</ul>
153+
<ul class="tsd-legend">
154+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
155+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
156+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
157+
</ul>
158+
<ul class="tsd-legend">
159+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
160+
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
161+
</ul>
162+
</div>
163+
</div>
164+
</footer>
165+
<div class="container tsd-generator">
166+
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
167+
</div>
168+
<div class="overlay"></div>
169+
<script src="assets/js/main.js"></script>
170+
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
171+
</body>
172+
</html>

0 commit comments

Comments
 (0)