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

Commit

Permalink
[fixed] minor. updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
thealjey committed Jan 8, 2016
1 parent 0ec2f02 commit 607ff33
Show file tree
Hide file tree
Showing 36 changed files with 84 additions and 84 deletions.
2 changes: 1 addition & 1 deletion docs/DevServer.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ <h1 class="page-title">Source: DevServer.js</h1>
/**
* recompiles SASS and notifies LiveReload
*
* @member {Function} compileSASS
* @method compileSASS
* @memberof DevServer
* @private
* @instance
Expand Down
2 changes: 1 addition & 1 deletion docs/Documentation.html
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ <h5>Returns:</h5>

<h5>Example</h5>

<pre class="sunlight-highlight-javascript">docs.run(function () {
<pre class="sunlight-highlight-javascript">docs.run(() =&gt; {
// generated the API documentation
});</pre>

Expand Down
8 changes: 4 additions & 4 deletions docs/Documentation.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ <h1 class="page-title">Source: Documentation.js</h1>
* @param {Function} [callback=function () {}] - a callback function
* @return {void}
* @example
* docs.run(function () {
* docs.run(() => {
* // generated the API documentation
* });
*/
Expand All @@ -240,7 +240,7 @@ <h1 class="page-title">Source: Documentation.js</h1>
* @param {NativeProcess} jsdoc - JSDoc3
* @param {Function} callback - a callback function
* @example
* docs.doRun(jsdoc, function () {
* docs.doRun(jsdoc, () => {
* // generated the API documentation
* });
*/
Expand All @@ -262,7 +262,7 @@ <h1 class="page-title">Source: Documentation.js</h1>
* @method findExecutable
* @param {FindExecutableCallback} callback - a callback function
* @example
* docs.findExecutable((file: string) => {
* docs.findExecutable(file => {
* // the jsdoc file is found
* });
*/
Expand Down Expand Up @@ -291,7 +291,7 @@ <h1 class="page-title">Source: Documentation.js</h1>
* @param {globalPackage} [boolean=false] - if true checks the global NPM bin directory (contains the npm
* executable itself)
* @example
* docs.checkBin((file: ?string) => {
* docs.checkBin(file => {
* if (file) {
* // the jsdoc file is found
* }
Expand Down
8 changes: 4 additions & 4 deletions docs/JS.html
Original file line number Diff line number Diff line change
Expand Up @@ -598,7 +598,7 @@ <h5>Returns:</h5>

<h5>Example</h5>

<pre class="sunlight-highlight-javascript">compiler.be(&#x27;/path/to/an/input/file.js&#x27;, &#x27;/path/to/the/output/file.js&#x27;, [&#x27;/lint/this/directory/too&#x27;], function () {
<pre class="sunlight-highlight-javascript">compiler.be(&#x27;/path/to/an/input/file.js&#x27;, &#x27;/path/to/the/output/file.js&#x27;, [&#x27;/lint/this/directory/too&#x27;], () =&gt; {
// the code has passed all the checks and has been compiled successfully
});</pre>

Expand Down Expand Up @@ -896,7 +896,7 @@ <h5>Returns:</h5>

<h5>Example</h5>

<pre class="sunlight-highlight-javascript">compiler.fe(&#x27;/path/to/an/input/file.js&#x27;, &#x27;/path/to/the/output/file.js&#x27;, [&#x27;/lint/this/directory/too&#x27;], function () {
<pre class="sunlight-highlight-javascript">compiler.fe(&#x27;/path/to/an/input/file.js&#x27;, &#x27;/path/to/the/output/file.js&#x27;, [&#x27;/lint/this/directory/too&#x27;], () =&gt; {
// the code has passed all the checks and has been compiled successfully
});</pre>

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

<h5>Example</h5>

<pre class="sunlight-highlight-javascript">js.lint([&#x27;/path/to/the/input/file.js&#x27;, &#x27;/lint/this/directory/too&#x27;], function () {
<pre class="sunlight-highlight-javascript">js.lint([&#x27;/path/to/the/input/file.js&#x27;, &#x27;/lint/this/directory/too&#x27;], () =&gt; {
// successfully linted
});</pre>

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

<h5>Example</h5>

<pre class="sunlight-highlight-javascript">js.typecheck(function () {
<pre class="sunlight-highlight-javascript">js.typecheck(() =&gt; {
// successfully typechecked
});</pre>

Expand Down
10 changes: 5 additions & 5 deletions docs/JS.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ <h1 class="page-title">Source: JS.js</h1>
* @method typecheck
* @param {Function} callback - a callback function, invoked only when successfully typechecked
* @example
* js.typecheck(function () {
* js.typecheck(() => {
* // successfully typechecked
* });
*/
Expand All @@ -164,7 +164,7 @@ <h1 class="page-title">Source: JS.js</h1>
* @param {Array&lt;string>} paths - an array of paths to files/directories to lint
* @param {Function} callback - a callback function, invoked only when successfully linted
* @example
* js.lint(['/path/to/the/input/file.js', '/lint/this/directory/too'], function () {
* js.lint(['/path/to/the/input/file.js', '/lint/this/directory/too'], () => {
* // successfully linted
* });
*/
Expand Down Expand Up @@ -193,7 +193,7 @@ <h1 class="page-title">Source: JS.js</h1>
* @param {Array&lt;string>} lintPaths - an array of paths to files/directories to lint
* @param {Function} callback - a callback function, invoked only when successfully validated
* @example
* js.validate('/path/to/the/input/file.js', ['/lint/this/directory/too'], function () {
* js.validate('/path/to/the/input/file.js', ['/lint/this/directory/too'], () => {
* // successfully validated
* });
*/
Expand All @@ -215,7 +215,7 @@ <h1 class="page-title">Source: JS.js</h1>
* @param {Function} [callback=function () {}] - a callback function
* @return {void}
* @example
* compiler.be('/path/to/an/input/file.js', '/path/to/the/output/file.js', ['/lint/this/directory/too'], function () {
* compiler.be('/path/to/an/input/file.js', '/path/to/the/output/file.js', ['/lint/this/directory/too'], () => {
* // the code has passed all the checks and has been compiled successfully
* });
*/
Expand All @@ -237,7 +237,7 @@ <h1 class="page-title">Source: JS.js</h1>
* @param {Function} [callback=function () {}] - a callback function
* @return {void}
* @example
* compiler.fe('/path/to/an/input/file.js', '/path/to/the/output/file.js', ['/lint/this/directory/too'], function () {
* compiler.fe('/path/to/an/input/file.js', '/path/to/the/output/file.js', ['/lint/this/directory/too'], () => {
* // the code has passed all the checks and has been compiled successfully
* });
*/
Expand Down
2 changes: 1 addition & 1 deletion docs/JSLint.html
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,7 @@ <h5>Example</h5>
<pre class="sunlight-highlight-javascript">// lint &quot;index.js&quot; as well as the entire contents of the &quot;src&quot; directory
linter.run([join(__dirname, &#x27;index.js&#x27;), join(__dirname, &#x27;src&#x27;)], function (err) {
if (err) {
return e.forEach(function (e) {
return e.forEach(e =&gt; {
console.log(&#x27;\x1b[41mESLint error\x1b[0m &quot;\x1b[33m%s%s\x1b[0m&quot; in \x1b[36m%s\x1b[0m on \x1b[35m%s:%s\x1b[0m&#x27;,
e.message, e.ruleId ? &#x60; (${e.ruleId})&#x60; : &#x27;&#x27;, e.filePath, e.line, e.column);
});
Expand Down
2 changes: 1 addition & 1 deletion docs/JSLint.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ <h1 class="page-title">Source: JSLint.js</h1>
* // lint "index.js" as well as the entire contents of the "src" directory
* linter.run([join(__dirname, 'index.js'), join(__dirname, 'src')], function (err) {
* if (err) {
* return e.forEach(function (e) {
* return e.forEach(e => {
* console.log('\x1b[41mESLint error\x1b[0m "\x1b[33m%s%s\x1b[0m" in \x1b[36m%s\x1b[0m on \x1b[35m%s:%s\x1b[0m',
* e.message, e.ruleId ? ` (${e.ruleId})` : '', e.filePath, e.line, e.column);
* });
Expand Down
6 changes: 3 additions & 3 deletions docs/NativeProcess.html
Original file line number Diff line number Diff line change
Expand Up @@ -601,9 +601,9 @@ <h5>Returns:</h5>

<h5>Example</h5>

<pre class="sunlight-highlight-javascript">mkdir.run(function (e) {
if (e) {
return console.error(e);
<pre class="sunlight-highlight-javascript">mkdir.run(error =&gt; {
if (error) {
return console.error(error);
}
// created a directory named &quot;example&quot; in cwd
}, [&#x27;example&#x27;]);</pre>
Expand Down
6 changes: 3 additions & 3 deletions docs/NativeProcess.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -137,9 +137,9 @@ <h1 class="page-title">Source: NativeProcess.js</h1>
* @param {Object} [opts={}] - a configuration object for the process
* @return {void}
* @example
* mkdir.run(function (e) {
* if (e) {
* return console.error(e);
* mkdir.run(error => {
* if (error) {
* return console.error(error);
* }
* // created a directory named "example" in cwd
* }, ['example']);
Expand Down
4 changes: 2 additions & 2 deletions docs/SASS.html
Original file line number Diff line number Diff line change
Expand Up @@ -639,7 +639,7 @@ <h5>Returns:</h5>

<h5>Example</h5>

<pre class="sunlight-highlight-javascript">compiler.fe(&#x27;/path/to/an/input/file.js&#x27;, &#x27;/path/to/the/output/file.js&#x27;, [&#x27;/lint/this/directory/too&#x27;], function () {
<pre class="sunlight-highlight-javascript">compiler.fe(&#x27;/path/to/an/input/file.js&#x27;, &#x27;/path/to/the/output/file.js&#x27;, [&#x27;/lint/this/directory/too&#x27;], () =&gt; {
// the code has passed all the checks and has been compiled successfully
});</pre>

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

<h5>Example</h5>

<pre class="sunlight-highlight-javascript">sass.lint([&#x27;/path/to/the/input/file.scss&#x27;, &#x27;/lint/this/directory/too&#x27;], function () {
<pre class="sunlight-highlight-javascript">sass.lint([&#x27;/path/to/the/input/file.scss&#x27;, &#x27;/lint/this/directory/too&#x27;], () =&gt; {
// successfully linted
});</pre>

Expand Down
4 changes: 2 additions & 2 deletions docs/SASS.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ <h1 class="page-title">Source: SASS.js</h1>
* @param {Array&lt;string>} paths - an array of paths to lint
* @param {Function} callback - a callback function
* @example
* sass.lint(['/path/to/the/input/file.scss', '/lint/this/directory/too'], function () {
* sass.lint(['/path/to/the/input/file.scss', '/lint/this/directory/too'], () => {
* // successfully linted
* });
*/
Expand All @@ -155,7 +155,7 @@ <h1 class="page-title">Source: SASS.js</h1>
* @param {Function} [callback=function () {}] - a callback function
* @return {void}
* @example
* compiler.fe('/path/to/an/input/file.js', '/path/to/the/output/file.js', ['/lint/this/directory/too'], function () {
* compiler.fe('/path/to/an/input/file.js', '/path/to/the/output/file.js', ['/lint/this/directory/too'], () => {
* // the code has passed all the checks and has been compiled successfully
* });
*/
Expand Down
4 changes: 2 additions & 2 deletions docs/SASSCompiler.html
Original file line number Diff line number Diff line change
Expand Up @@ -601,7 +601,7 @@ <h5>Parameters:</h5>

<h5>Example</h5>

<pre class="sunlight-highlight-javascript">compiler.autoprefix(&#x27;/path/to/the/output/file.css&#x27;, data, function (autoprefixedData) {
<pre class="sunlight-highlight-javascript">compiler.autoprefix(&#x27;/path/to/the/output/file.css&#x27;, data, result =&gt; {
// successfully added the vendor prefixes
});</pre>

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

<h5>Example</h5>

<pre class="sunlight-highlight-javascript">compiler.fe(&#x27;/path/to/the/input/file.scss&#x27;, &#x27;/path/to/the/output/file.css&#x27;, function () {
<pre class="sunlight-highlight-javascript">compiler.fe(&#x27;/path/to/the/input/file.scss&#x27;, &#x27;/path/to/the/output/file.css&#x27;, () =&gt; {
// compiled successfully
});</pre>

Expand Down
4 changes: 2 additions & 2 deletions docs/SASSCompiler.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ <h1 class="page-title">Source: SASSCompiler.js</h1>
* @param {ProgramData} data - the actual program data to auto-prefix
* @param {AutoprefixCallback} callback - a callback function
* @example
* compiler.autoprefix('/path/to/the/output/file.css', data, function (autoprefixedData) {
* compiler.autoprefix('/path/to/the/output/file.css', data, result => {
* // successfully added the vendor prefixes
* });
*/
Expand Down Expand Up @@ -221,7 +221,7 @@ <h1 class="page-title">Source: SASSCompiler.js</h1>
* @param {string} outPath - a full system path to the output file
* @param {Function} [callback=function () {}] - a callback function
* @example
* compiler.fe('/path/to/the/input/file.scss', '/path/to/the/output/file.css', function () {
* compiler.fe('/path/to/the/input/file.scss', '/path/to/the/output/file.css', () => {
* // compiled successfully
* });
*/
Expand Down
6 changes: 3 additions & 3 deletions docs/SASSLint.html
Original file line number Diff line number Diff line change
Expand Up @@ -424,9 +424,9 @@ <h5>Parameters:</h5>
<h5>Example</h5>

<pre class="sunlight-highlight-javascript">// lint &quot;style.scss&quot; as well as the entire contents of the &quot;sass&quot; directory
linter.run([join(__dirname, &#x27;style.scss&#x27;), join(__dirname, &#x27;sass&#x27;)], function (e) {
if (e) {
return console.error(e);
linter.run([join(__dirname, &#x27;style.scss&#x27;), join(__dirname, &#x27;sass&#x27;)], error =&gt; {
if (error) {
return console.error(error);
}
// there were no linting errors
});</pre>
Expand Down
6 changes: 3 additions & 3 deletions docs/SASSLint.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ <h1 class="page-title">Source: SASSLint.js</h1>
* @param {Function} callback - a callback function, accepts 1 argument: an error message or null
* @example
* // lint "style.scss" as well as the entire contents of the "sass" directory
* linter.run([join(__dirname, 'style.scss'), join(__dirname, 'sass')], function (e) {
* if (e) {
* return console.error(e);
* linter.run([join(__dirname, 'style.scss'), join(__dirname, 'sass')], error => {
* if (error) {
* return console.error(error);
* }
* // there were no linting errors
* });
Expand Down
2 changes: 1 addition & 1 deletion docs/global.html
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@ <h5>Example</h5>
<pre class="sunlight-highlight-javascript">import {yaml} from &#x27;webcompiler&#x27;;
import {join} from &#x27;path&#x27;;

yaml(join(__dirname, &#x27;config&#x27;, &#x27;config.yml&#x27;), function (error, data) {
yaml(join(__dirname, &#x27;config&#x27;, &#x27;config.yml&#x27;), (error, data) =&gt; {
if (error) {
return console.error(error);
}
Expand Down
2 changes: 1 addition & 1 deletion docs/quicksearch.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/yaml.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ <h1 class="page-title">Source: yaml.js</h1>
* import {yaml} from 'webcompiler';
* import {join} from 'path';
*
* yaml(join(__dirname, 'config', 'config.yml'), function (error, data) {
* yaml(join(__dirname, 'config', 'config.yml'), (error, data) => {
* if (error) {
* return console.error(error);
* }
Expand Down
2 changes: 1 addition & 1 deletion lib/DevServer.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ var DevServer = exports.DevServer = function () {
/**
* recompiles SASS and notifies LiveReload
*
* @member {Function} compileSASS
* @method compileSASS
* @memberof DevServer
* @private
* @instance
Expand Down
8 changes: 4 additions & 4 deletions lib/Documentation.js
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ var Documentation = exports.Documentation = function () {
* @param {Function} [callback=function () {}] - a callback function
* @return {void}
* @example
* docs.run(function () {
* docs.run(() => {
* // generated the API documentation
* });
*/
Expand Down Expand Up @@ -190,7 +190,7 @@ var Documentation = exports.Documentation = function () {
* @param {NativeProcess} jsdoc - JSDoc3
* @param {Function} callback - a callback function
* @example
* docs.doRun(jsdoc, function () {
* docs.doRun(jsdoc, () => {
* // generated the API documentation
* });
*/
Expand All @@ -215,7 +215,7 @@ var Documentation = exports.Documentation = function () {
* @method findExecutable
* @param {FindExecutableCallback} callback - a callback function
* @example
* docs.findExecutable((file: string) => {
* docs.findExecutable(file => {
* // the jsdoc file is found
* });
*/
Expand Down Expand Up @@ -249,7 +249,7 @@ var Documentation = exports.Documentation = function () {
* @param {globalPackage} [boolean=false] - if true checks the global NPM bin directory (contains the npm
* executable itself)
* @example
* docs.checkBin((file: ?string) => {
* docs.checkBin(file => {
* if (file) {
* // the jsdoc file is found
* }
Expand Down
10 changes: 5 additions & 5 deletions lib/JS.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ var JS = exports.JS = function () {
* @method typecheck
* @param {Function} callback - a callback function, invoked only when successfully typechecked
* @example
* js.typecheck(function () {
* js.typecheck(() => {
* // successfully typechecked
* });
*/
Expand Down Expand Up @@ -113,7 +113,7 @@ var JS = exports.JS = function () {
* @param {Array<string>} paths - an array of paths to files/directories to lint
* @param {Function} callback - a callback function, invoked only when successfully linted
* @example
* js.lint(['/path/to/the/input/file.js', '/lint/this/directory/too'], function () {
* js.lint(['/path/to/the/input/file.js', '/lint/this/directory/too'], () => {
* // successfully linted
* });
*/
Expand Down Expand Up @@ -143,7 +143,7 @@ var JS = exports.JS = function () {
* @param {Array<string>} lintPaths - an array of paths to files/directories to lint
* @param {Function} callback - a callback function, invoked only when successfully validated
* @example
* js.validate('/path/to/the/input/file.js', ['/lint/this/directory/too'], function () {
* js.validate('/path/to/the/input/file.js', ['/lint/this/directory/too'], () => {
* // successfully validated
* });
*/
Expand All @@ -170,7 +170,7 @@ var JS = exports.JS = function () {
* @param {Function} [callback=function () {}] - a callback function
* @return {void}
* @example
* compiler.be('/path/to/an/input/file.js', '/path/to/the/output/file.js', ['/lint/this/directory/too'], function () {
* compiler.be('/path/to/an/input/file.js', '/path/to/the/output/file.js', ['/lint/this/directory/too'], () => {
* // the code has passed all the checks and has been compiled successfully
* });
*/
Expand Down Expand Up @@ -200,7 +200,7 @@ var JS = exports.JS = function () {
* @param {Function} [callback=function () {}] - a callback function
* @return {void}
* @example
* compiler.fe('/path/to/an/input/file.js', '/path/to/the/output/file.js', ['/lint/this/directory/too'], function () {
* compiler.fe('/path/to/an/input/file.js', '/path/to/the/output/file.js', ['/lint/this/directory/too'], () => {
* // the code has passed all the checks and has been compiled successfully
* });
*/
Expand Down
2 changes: 1 addition & 1 deletion lib/JSLint.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ var JSLint = exports.JSLint = function () {
* // lint "index.js" as well as the entire contents of the "src" directory
* linter.run([join(__dirname, 'index.js'), join(__dirname, 'src')], function (err) {
* if (err) {
* return e.forEach(function (e) {
* return e.forEach(e => {
* console.log('\x1b[41mESLint error\x1b[0m "\x1b[33m%s%s\x1b[0m" in \x1b[36m%s\x1b[0m on \x1b[35m%s:%s\x1b[0m',
* e.message, e.ruleId ? ` (${e.ruleId})` : '', e.filePath, e.line, e.column);
* });
Expand Down
Loading

0 comments on commit 607ff33

Please sign in to comment.