Skip to content

Commit 285846a

Browse files
committed
add JSdoc & documentation
1 parent 47de46a commit 285846a

150 files changed

Lines changed: 28116 additions & 643 deletions

File tree

Some content is hidden

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

.eslintignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
coverage
33
test
44
dist
5+
docs

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ __testfixtures__
1212
*.input.js
1313
types.js
1414
*.spec.js
15+
docs

.travis.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@ sudo: false
1111
notifications:
1212
email: false
1313

14-
before_install:
15-
- yarn global add eslint
16-
- yarn global add eslint-plugin-node
17-
- yarn global add eslint-plugin-flowtype
1814
before_script:
1915
- export DISPLAY=:99.0
2016
- sh -e /etc/init.d/xvfb start

docs/AddGenerator.html

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<title>JSDoc: Class: AddGenerator</title>
6+
7+
<script src="scripts/prettify/prettify.js"> </script>
8+
<script src="scripts/prettify/lang-css.js"> </script>
9+
<!--[if lt IE 9]>
10+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11+
<![endif]-->
12+
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13+
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14+
</head>
15+
16+
<body>
17+
18+
<div id="main">
19+
20+
<h1 class="page-title">Class: AddGenerator</h1>
21+
22+
23+
24+
25+
26+
27+
<section>
28+
29+
<header>
30+
31+
<h2><span class="attribs"><span class="type-signature"></span></span>AddGenerator<span class="signature">()</span><span class="type-signature"> &rarr; {Void}</span></h2>
32+
33+
34+
</header>
35+
36+
<article>
37+
<div class="container-overview">
38+
39+
40+
41+
42+
43+
44+
<h4 class="name" id="AddGenerator"><span class="type-signature"></span>new AddGenerator<span class="signature">()</span><span class="type-signature"> &rarr; {Void}</span></h4>
45+
46+
47+
48+
49+
50+
51+
<div class="description">
52+
Generator for adding properties
53+
</div>
54+
55+
56+
57+
58+
59+
60+
61+
62+
63+
64+
65+
66+
67+
<dl class="details">
68+
69+
70+
71+
72+
73+
74+
75+
76+
77+
78+
79+
80+
81+
82+
83+
84+
85+
86+
87+
88+
89+
90+
91+
92+
93+
94+
<dt class="tag-source">Source:</dt>
95+
<dd class="tag-source"><ul class="dummy"><li>
96+
<a href="generators_add-generator.js.html">generators/add-generator.js</a>, <a href="generators_add-generator.js.html#line49">line 49</a>
97+
</li></ul></dd>
98+
99+
100+
101+
102+
103+
104+
105+
</dl>
106+
107+
108+
109+
110+
111+
112+
113+
114+
115+
116+
117+
118+
119+
<h5>Returns:</h5>
120+
121+
122+
<div class="param-desc">
123+
After execution, transforms are triggered
124+
</div>
125+
126+
127+
128+
<dl>
129+
<dt>
130+
Type
131+
</dt>
132+
<dd>
133+
134+
<span class="param-type">Void</span>
135+
136+
137+
</dd>
138+
</dl>
139+
140+
141+
142+
143+
144+
145+
146+
147+
</div>
148+
149+
150+
<h3 class="subsection-title">Extends</h3>
151+
152+
153+
154+
155+
<ul>
156+
<li>Generator</li>
157+
</ul>
158+
159+
160+
161+
162+
163+
164+
165+
166+
167+
168+
169+
170+
171+
172+
173+
174+
175+
176+
177+
178+
179+
</article>
180+
181+
</section>
182+
183+
184+
185+
186+
</div>
187+
188+
<nav>
189+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AddGenerator.html">AddGenerator</a></li><li><a href="InitGenerator.html">InitGenerator</a></li><li><a href="LoaderGenerator.html">LoaderGenerator</a></li><li><a href="PluginGenerator.html">PluginGenerator</a></li></ul><h3>Global</h3><ul><li><a href="global.html#checkIfExistsAndAddValue">checkIfExistsAndAddValue</a></li><li><a href="global.html#createArrayWithChildren">createArrayWithChildren</a></li><li><a href="global.html#createEmptyArrayProperty">createEmptyArrayProperty</a></li><li><a href="global.html#createEmptyCallableFunctionWithArguments">createEmptyCallableFunctionWithArguments</a></li><li><a href="global.html#createExternalRegExp">createExternalRegExp</a></li><li><a href="global.html#createIdentifierOrLiteral">createIdentifierOrLiteral</a></li><li><a href="global.html#createLiteral">createLiteral</a></li><li><a href="global.html#createObjectWithSuppliedProperty">createObjectWithSuppliedProperty</a></li><li><a href="global.html#createOrUpdatePluginByName">createOrUpdatePluginByName</a></li><li><a href="global.html#createProperty">createProperty</a></li><li><a href="global.html#creator">creator</a></li><li><a href="global.html#defineTest">defineTest</a></li><li><a href="global.html#findPluginsByName">findPluginsByName</a></li><li><a href="global.html#findRootNodesByName">findRootNodesByName</a></li><li><a href="global.html#findVariableToPlugin">findVariableToPlugin</a></li><li><a href="global.html#generatorCopy">generatorCopy</a></li><li><a href="global.html#generatorCopyTpl">generatorCopyTpl</a></li><li><a href="global.html#getPackageManager">getPackageManager</a></li><li><a href="global.html#getRequire">getRequire</a></li><li><a href="global.html#isAssignment">isAssignment</a></li><li><a href="global.html#isType">isType</a></li><li><a href="global.html#loaderCreator">loaderCreator</a></li><li><a href="global.html#loopThroughObjects">loopThroughObjects</a></li><li><a href="global.html#makeLoaderName">makeLoaderName</a></li><li><a href="global.html#pluginCreator">pluginCreator</a></li><li><a href="global.html#processPromise">processPromise</a></li><li><a href="global.html#pushCreateProperty">pushCreateProperty</a></li><li><a href="global.html#pushObjectKeys">pushObjectKeys</a></li><li><a href="global.html#replaceAt">replaceAt</a></li><li><a href="global.html#runSingleTansform">runSingleTansform</a></li><li><a href="global.html#spawnChild">spawnChild</a></li><li><a href="global.html#spawnNPM">spawnNPM</a></li><li><a href="global.html#spawnYarn">spawnYarn</a></li><li><a href="global.html#transformsObject">transformsObject</a></li><li><a href="global.html#traverseAndGetProperties">traverseAndGetProperties</a></li><li><a href="global.html#webpackGenerator">webpackGenerator</a></li></ul>
190+
</nav>
191+
192+
<br class="clear">
193+
194+
<footer>
195+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Dec 18 2017 13:12:38 GMT+0100 (CET)
196+
</footer>
197+
198+
<script> prettyPrint(); </script>
199+
<script src="scripts/linenumber.js"> </script>
200+
</body>
201+
</html>

0 commit comments

Comments
 (0)