Skip to content
This repository has been archived by the owner on Jul 9, 2021. It is now read-only.

Commit

Permalink
[changed] the markdown JSDoc plugin is now included by default; added…
Browse files Browse the repository at this point in the history 
… a broader description of the default plugin to the Documentation class
  • Loading branch information
@thealjey
thealjey committed Dec 31, 2015
1 parent 111046e commit 6da6e97
Show file tree
Hide file tree
Showing 34 changed files with 298 additions and 236 deletions.
2 changes: 1 addition & 1 deletion config/jsdoc.json
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"plugins": ["jsdocPlugin.js"],
"plugins": ["jsdocPlugin.js", "plugins/markdown"],
"templates": {
"includeDate": false,
"linenums": true,
Expand Down
46 changes: 23 additions & 23 deletions docs/Compiler.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ <h4 class="name" id="Compiler"><span class="type-signature">&lt;abstract> </span


<div class="description">
The base compiler class
<p>The base compiler class</p>
</div>


Expand Down Expand Up @@ -199,8 +199,8 @@ <h4><span class="type-signature">&lt;readonly> </span>isProduction<span class="t
<dd>

<div class="description">
True if the NODE_ENV environment variable is equal to 'production'.
Caution: modifying it's value directly may lead to unexpected results
<p>True if the NODE_ENV environment variable is equal to <code>production</code>.</p>
<p>Caution: modifying it's value directly may lead to unexpected results</p>
</div>


Expand Down Expand Up @@ -288,7 +288,7 @@ <h4 class="name" id="done"><span class="type-signature">&lt;protected> </span>do


<div class="description">
Executed when the compilation is complete
<p>Executed when the compilation is complete</p>
</div>


Expand Down Expand Up @@ -340,7 +340,7 @@ <h5>Parameters:</h5>



<td class="description last">the input path</td>
<td class="description last"><p>the input path</p></td>
</tr>


Expand All @@ -364,7 +364,7 @@ <h5>Parameters:</h5>



<td class="description last">a callback function</td>
<td class="description last"><p>a callback function</p></td>
</tr>


Expand Down Expand Up @@ -409,7 +409,7 @@ <h5>Parameters:</h5>
<ul class="dummy">
<li>
<a href="Compiler.js.html">Compiler.js</a>,
<a href="Compiler.js.html#sunlight-1-line-54">line 54</a>
<a href="Compiler.js.html#sunlight-1-line-55">line 55</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -456,7 +456,7 @@ <h4 class="name" id="fsWrite"><span class="type-signature">&lt;protected> </span


<div class="description">
Writes the data to disk
<p>Writes the data to disk</p>
</div>


Expand Down Expand Up @@ -508,7 +508,7 @@ <h5>Parameters:</h5>



<td class="description last">the output path</td>
<td class="description last"><p>the output path</p></td>
</tr>


Expand All @@ -532,7 +532,7 @@ <h5>Parameters:</h5>



<td class="description last">the data to write</td>
<td class="description last"><p>the data to write</p></td>
</tr>


Expand All @@ -556,7 +556,7 @@ <h5>Parameters:</h5>



<td class="description last">a callback function</td>
<td class="description last"><p>a callback function</p></td>
</tr>


Expand Down Expand Up @@ -601,7 +601,7 @@ <h5>Parameters:</h5>
<ul class="dummy">
<li>
<a href="Compiler.js.html">Compiler.js</a>,
<a href="Compiler.js.html#sunlight-1-line-71">line 71</a>
<a href="Compiler.js.html#sunlight-1-line-72">line 72</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -648,7 +648,7 @@ <h4 class="name" id="minify"><span class="type-signature">&lt;abstract> </span>m


<div class="description">
Minifies the compiled code
<p>Minifies the compiled code</p>
</div>


Expand Down Expand Up @@ -700,7 +700,7 @@ <h5>Parameters:</h5>



<td class="description last">a path to the file (can be used for the sourceMappingURL comment)</td>
<td class="description last"><p>a path to the file (can be used for the sourceMappingURL comment)</p></td>
</tr>


Expand All @@ -724,7 +724,7 @@ <h5>Parameters:</h5>



<td class="description last">the actual program data to compress</td>
<td class="description last"><p>the actual program data to compress</p></td>
</tr>


Expand Down Expand Up @@ -769,7 +769,7 @@ <h5>Parameters:</h5>
<ul class="dummy">
<li>
<a href="Compiler.js.html">Compiler.js</a>,
<a href="Compiler.js.html#sunlight-1-line-41">line 41</a>
<a href="Compiler.js.html#sunlight-1-line-42">line 42</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -798,7 +798,7 @@ <h5>Returns:</h5>


<div class="param-desc">
processed application code with source maps or null on error
<p>processed application code with source maps or null on error</p>
</div>


Expand Down Expand Up @@ -834,7 +834,7 @@ <h4 class="name" id="optimize"><span class="type-signature">&lt;protected> </spa


<div class="description">
Minifies and g-zips the program
<p>Minifies and g-zips the program</p>
</div>


Expand Down Expand Up @@ -886,7 +886,7 @@ <h5>Parameters:</h5>



<td class="description last">the input path</td>
<td class="description last"><p>the input path</p></td>
</tr>


Expand All @@ -910,7 +910,7 @@ <h5>Parameters:</h5>



<td class="description last">the output path</td>
<td class="description last"><p>the output path</p></td>
</tr>


Expand All @@ -934,7 +934,7 @@ <h5>Parameters:</h5>



<td class="description last">processed application code with source maps</td>
<td class="description last"><p>processed application code with source maps</p></td>
</tr>


Expand All @@ -958,7 +958,7 @@ <h5>Parameters:</h5>



<td class="description last">a callback function</td>
<td class="description last"><p>a callback function</p></td>
</tr>


Expand Down Expand Up @@ -1003,7 +1003,7 @@ <h5>Parameters:</h5>
<ul class="dummy">
<li>
<a href="Compiler.js.html">Compiler.js</a>,
<a href="Compiler.js.html#sunlight-1-line-106">line 106</a>
<a href="Compiler.js.html#sunlight-1-line-107">line 107</a>
</li>
</ul>
</dd>
Expand Down
3 changes: 2 additions & 1 deletion docs/Compiler.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,8 @@ <h1 class="page-title">Source: Compiler.js</h1>
*/
export class Compiler {
/**
* True if the NODE_ENV environment variable is equal to 'production'.
* True if the NODE_ENV environment variable is equal to `production`.
*
* Caution: modifying it's value directly may lead to unexpected results
*
* @member {boolean} isProduction
Expand Down
36 changes: 18 additions & 18 deletions docs/DevServer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,11 @@ <h4 class="name" id="DevServer"><span class="type-signature"></span>new DevServe


<div class="description">
A lightweight development server that rapidly recompiles the JavaScript and SASS files when they are edited and
updates the page.
Utilizes the Webpack development server.
Includes react hot loader to further optimize the development process of the React applications.
Please install and enable the LiveReload browser extension for the CSS reloading to work.
<p>A lightweight development server that rapidly recompiles the JavaScript and SASS files when they are edited and
updates the page.</p>
<p>Utilizes the Webpack development server.</p>
<p>Includes react hot loader to further optimize the development process of the React applications.</p>
<p>Please install and enable the LiveReload browser extension for the CSS reloading to work.</p>
</div>


Expand Down Expand Up @@ -168,7 +168,7 @@ <h5>Parameters:</h5>
</td>


<td class="description last">a full system path to a JavaScript file</td>
<td class="description last"><p>a full system path to a JavaScript file</p></td>
</tr>


Expand Down Expand Up @@ -204,7 +204,7 @@ <h5>Parameters:</h5>
</td>


<td class="description last">a full system path to a SASS file</td>
<td class="description last"><p>a full system path to a SASS file</p></td>
</tr>


Expand Down Expand Up @@ -240,7 +240,7 @@ <h5>Parameters:</h5>
</td>


<td class="description last">a full system path to a directory in which to put any compiled development resources</td>
<td class="description last"><p>a full system path to a directory in which to put any compiled development resources</p></td>
</tr>


Expand Down Expand Up @@ -280,7 +280,7 @@ <h5>Parameters:</h5>
</td>


<td class="description last">a port at which to start the dev server</td>
<td class="description last"><p>a port at which to start the dev server</p></td>
</tr>


Expand Down Expand Up @@ -320,7 +320,7 @@ <h5>Parameters:</h5>
</td>


<td class="description last">false to disable the react hot loader plugin</td>
<td class="description last"><p>false to disable the react hot loader plugin</p></td>
</tr>


Expand Down Expand Up @@ -445,7 +445,7 @@ <h4 class="name" id="run"><span class="type-signature"></span>run(watchDir)</h4>


<div class="description">
Starts the Webpack development server, compiles SASS and starts watching for file changes
<p>Starts the Webpack development server, compiles SASS and starts watching for file changes</p>
</div>


Expand Down Expand Up @@ -497,7 +497,7 @@ <h5>Parameters:</h5>



<td class="description last">the directory in which to watch for the changes in the SASS files</td>
<td class="description last"><p>the directory in which to watch for the changes in the SASS files</p></td>
</tr>


Expand Down Expand Up @@ -542,7 +542,7 @@ <h5>Parameters:</h5>
<ul class="dummy">
<li>
<a href="DevServer.js.html">DevServer.js</a>,
<a href="DevServer.js.html#sunlight-1-line-178">line 178</a>
<a href="DevServer.js.html#sunlight-1-line-181">line 181</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -589,7 +589,7 @@ <h4 class="name" id="watchJS"><span class="type-signature"></span>watchJS()</h4>


<div class="description">
Starts the Webpack development server
<p>Starts the Webpack development server</p>
</div>


Expand Down Expand Up @@ -636,7 +636,7 @@ <h4 class="name" id="watchJS"><span class="type-signature"></span>watchJS()</h4>
<ul class="dummy">
<li>
<a href="DevServer.js.html">DevServer.js</a>,
<a href="DevServer.js.html#sunlight-1-line-158">line 158</a>
<a href="DevServer.js.html#sunlight-1-line-161">line 161</a>
</li>
</ul>
</dd>
Expand Down Expand Up @@ -683,7 +683,7 @@ <h4 class="name" id="watchSASS"><span class="type-signature"></span>watchSASS(wa


<div class="description">
Compile SASS and start watching for file changes
<p>Compile SASS and start watching for file changes</p>
</div>


Expand Down Expand Up @@ -735,7 +735,7 @@ <h5>Parameters:</h5>



<td class="description last">the directory in which to watch for the changes in the SASS files</td>
<td class="description last"><p>the directory in which to watch for the changes in the SASS files</p></td>
</tr>


Expand Down Expand Up @@ -780,7 +780,7 @@ <h5>Parameters:</h5>
<ul class="dummy">
<li>
<a href="DevServer.js.html">DevServer.js</a>,
<a href="DevServer.js.html#sunlight-1-line-142">line 142</a>
<a href="DevServer.js.html#sunlight-1-line-145">line 145</a>
</li>
</ul>
</dd>
Expand Down
3 changes: 3 additions & 0 deletions docs/DevServer.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,11 @@ <h1 class="page-title">Source: DevServer.js</h1>
/**
* A lightweight development server that rapidly recompiles the JavaScript and SASS files when they are edited and
* updates the page.
*
* Utilizes the Webpack development server.
*
* Includes react hot loader to further optimize the development process of the React applications.
*
* Please install and enable the LiveReload browser extension for the CSS reloading to work.
*
* @class DevServer
Expand Down
Loading

0 comments on commit 6da6e97

Please sign in to comment.