Skip to content

Commit

Permalink
docs(api): update API docs
Browse files Browse the repository at this point in the history 
#44,#187
  • Loading branch information
@gregswindle
gregswindle committed Feb 18, 2018
1 parent 2a883c5 commit 1453fc2
Show file tree
Hide file tree
Showing 41 changed files with 352 additions and 343 deletions.
11 changes: 5 additions & 6 deletions .github/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -884,13 +884,12 @@
<!-- AUTO-GENERATED-CONTENT:START (DEPENDENCYTABLE) -->
| **Dependency** | **Description** | **Version** | **License** | **Type** |
| -------------- | --------------- | ----------- | ----------- | -------- |
| [airbrake-js@1.0.5](https://github.com/airbrake/airbrake-js#readme) | Notify Airbrake on JavaScript exceptions | 1.0.5 | MIT | production |
| [bunyan@1.8.12](https://github.com/trentm/node-bunyan#readme) | a JSON logging library for node.js services | 1.8.12 | MIT | production |
| [chalk@2.3.1](https://github.com/chalk/chalk#readme) | Terminal string styling done right | 2.3.1 | MIT | production |
| [compromise@11.3.0](https://github.com/nlp-compromise/compromise#readme) | natural language processing in the browser | 11.3.0 | MIT | production |
| [compromise@11.4.0](https://github.com/nlp-compromise/compromise#readme) | natural language processing in the browser | 11.4.0 | MIT | production |
| [doctrine@2.1.0](https://github.com/eslint/doctrine) | JSDoc parser | 2.1.0 | Apache-2.0 | production |
| [escomplex@2.0.0-alpha](https://github.com/jared-stilwell/escomplex) | Software complexity analysis of JavaScript-family abstract syntax trees. | 2.0.0-alpha | MIT | production |
| [eslint@4.17.0](https://eslint.org) | An AST-based pattern checker for JavaScript. | 4.17.0 | MIT | production |
| [eslint@4.18.0](https://eslint.org) | An AST-based pattern checker for JavaScript. | 4.18.0 | MIT | production |
| [eslint-scope@3.7.1](http://github.com/eslint/eslint-scope) | ECMAScript scope analyzer for ESLint | 3.7.1 | BSD-2-Clause | production |
| [espree@3.5.3](https://github.com/eslint/espree) | An Esprima-compatible JavaScript parser built on Acorn | 3.5.3 | BSD-2-Clause | production |
| [esquery@1.0.0](https://github.com/jrfeenst/esquery#readme) | A query library for ECMAScript AST using a CSS selector like query language. | 1.0.0 | BSD | production |
Expand All @@ -908,7 +907,7 @@
| [docdash@0.4.0](https://github.com/clenemt/docdash#readme) | A clean, responsive documentation template theme for JSDoc 3 inspired by lodash and minami | 0.4.0 | Apache-2.0 | dev |
| [eslint-config-crockford@2.0.0](https://github.com/ssoloff/eslint-config-crockford) | ESLint shareable config for Crockford style | 2.0.0 | MIT | dev |
| [eslint-config-scanjs@1.0.0-beta4](https://github.com/mozfreddyb/eslint-config-scanjs#readme) | umbrella config to get scanjs-like functionality from eslint | 1.0.0-beta4 | MPL-2.0 | dev |
| [eslint-config-xo-space@0.17.0](https://github.com/sindresorhus/eslint-config-xo-space#readme) | ESLint shareable config for XO with 2-space indent | 0.17.0 | MIT | dev |
| [eslint-config-xo-space@0.18.0](https://github.com/xojs/eslint-config-xo-space#readme) | ESLint shareable config for XO with 2-space indent | 0.18.0 | MIT | dev |
| [eslint-plugin-import@2.8.0](https://github.com/benmosher/eslint-plugin-import) | Import with sanity. | 2.8.0 | MIT | dev |
| [eslint-plugin-jsdoc@3.4.1](https://github.com/gajus/eslint-plugin-jsdoc#readme) | JSDoc linting rules for ESLint. | 3.4.1 | BSD-3-Clause | dev |
| [eslint-plugin-node@6.0.0](https://github.com/mysticatea/eslint-plugin-node#readme) | Additional ESLint's rules for Node.js | 6.0.0 | MIT | dev |
Expand All @@ -924,8 +923,8 @@
| [markdown-magic-dependency-table@1.3.2](https://github.com/camacho/markdown-magic-dependency-table#readme) | Generate table of information about dependencies automatically in markdown | 1.3.2 | MIT | dev |
| [markdown-magic-package-scripts@1.2.1](https://github.com/camacho/markdown-magic-package-scripts#readme) | Print list of scripts in package.json with descriptions | 1.2.1 | MIT | dev |
| [mocha@5.0.1](https://mochajs.org) | simple, flexible, fun test framework | 5.0.1 | MIT | dev |
| [nodemon@1.14.12](http://nodemon.io) | Simple monitor script for use during development of a node.js app. | 1.14.12 | MIT | dev |
| [nsp@3.1.0](https://github.com/nodesecurity/nsp#readme) | The Node Security (nodesecurity.io) command line interface | 3.1.0 | Apache-2.0 | dev |
| [nodemon@1.15.0](http://nodemon.io) | Simple monitor script for use during development of a node.js app. | 1.15.0 | MIT | dev |
| [nsp@3.2.1](https://github.com/nodesecurity/nsp#readme) | The Node Security (nodesecurity.io) command line interface | 3.2.1 | Apache-2.0 | dev |
| [nyc@11.4.1](https://github.com/istanbuljs/nyc#readme) | the Istanbul command line interface | 11.4.1 | ISC | dev |
| [properties-parser@0.3.1](https://github.com/xavi-/node-properties-parser#readme) | A parser for .properties files written in javascript | 0.3.1 | MIT | dev |
| [semantic-release@^12.4.1](https://github.com/semantic-release/semantic-release#readme) | Automated semver compliant package publishing | 12.4.1 | MIT | dev |
Expand Down
62 changes: 55 additions & 7 deletions docs/api/eslint-plugin-crc/0.1.5-development/CrcClass.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<label for="nav-trigger" class="overlay"></label>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CrcClass.html">CrcClass</a><ul class='members'><li data-type='member'><a href="CrcClass.html#.nullObject">nullObject</a></li></ul><ul class='methods'><li data-type='method'><a href="CrcClass.html#.create">create</a></li></ul></li><li><a href="CrcCodebase.html">CrcCodebase</a><ul class='methods'><li data-type='method'><a href="CrcCodebase.html#load">load</a></li></ul></li><li><a href="CrcContext.html">CrcContext</a><ul class='members'><li data-type='member'><a href="CrcContext.html#.nullObject">nullObject</a></li></ul><ul class='methods'><li data-type='method'><a href="CrcContext.html#.parse">parse</a></li></ul></li><li><a href="CrcMeta.html">CrcMeta</a><ul class='members'><li data-type='member'><a href="CrcMeta.html#.nullObject">nullObject</a></li></ul></li><li><a href="CrcModel.html">CrcModel</a><ul class='members'><li data-type='member'><a href="CrcModel.html#.nullObject">nullObject</a></li></ul></li><li><a href="CrcReporter.html">CrcReporter</a><ul class='methods'><li data-type='method'><a href="CrcReporter.html#report">report</a></li></ul></li><li><a href="CrcResponsibility.html">CrcResponsibility</a><ul class='methods'><li data-type='method'><a href="CrcResponsibility.html#.assign">assign</a></li><li data-type='method'><a href="CrcResponsibility.html#.create">create</a></li><li data-type='method'><a href="CrcResponsibility.html#.descriptionFromContext">descriptionFromContext</a></li></ul></li><li><a href="EsImgMap.html">EsImgMap</a><ul class='methods'><li data-type='method'><a href="EsImgMap.html#findByDescriptor">findByDescriptor</a></li><li data-type='method'><a href="EsImgMap.html#findByEsVersion">findByEsVersion</a></li><li data-type='method'><a href="EsImgMap.html#toHtmlLinkElemString">toHtmlLinkElemString</a></li></ul></li><li><a href="MdnReference.html">MdnReference</a><ul class='methods'><li data-type='method'><a href="MdnReference.html#get">get</a></li><li data-type='method'><a href="MdnReference.html#link">link</a></li></ul></li><li><a href="NodeManager.html">NodeManager</a><ul class='methods'><li data-type='method'><a href="NodeManager.html#.getAllNodes">getAllNodes</a></li><li data-type='method'><a href="NodeManager.html#.getNamespace">getNamespace</a></li><li data-type='method'><a href="NodeManager.html#.getNodeName">getNodeName</a></li></ul></li><li><a href="NullCrcClass.html">NullCrcClass</a></li><li><a href="NullCrcContext.html">NullCrcContext</a></li><li><a href="NullCrcMeta.html">NullCrcMeta</a></li><li><a href="NullCrcModel.html">NullCrcModel</a></li><li><a href="NullSourceCode.html">NullSourceCode</a></li><li><a href="SourceCodeFactory.html">SourceCodeFactory</a><ul class='members'><li data-type='member'><a href="SourceCodeFactory.html#.nullObject">nullObject</a></li></ul><ul class='methods'><li data-type='method'><a href="SourceCodeFactory.html#.create">create</a></li><li data-type='method'><a href="SourceCodeFactory.html#.parse">parse</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-eslint-plugin-crc.html">eslint-plugin-crc</a></li><li><a href="module-eslint-plugin-crc_crc.html">eslint-plugin-crc/crc</a></li><li><a href="module-eslint-plugin-crc_formatters_md.html">eslint-plugin-crc/formatters/md</a><ul class='methods'><li data-type='method'><a href="module-eslint-plugin-crc_formatters_md.html#~format">format</a></li></ul></li></ul><h3>Interfaces</h3><ul><li><a href="LinkElement.html">LinkElement</a></li></ul><h3>Global</h3><ul><li><a href="global.html#astConfig">astConfig</a></li><li><a href="global.html#copyAssets">copyAssets</a></li><li><a href="global.html#esImgMap">esImgMap</a></li><li><a href="global.html#generateReport">generateReport</a></li><li><a href="global.html#main">main</a></li><li><a href="global.html#options">options</a></li><li><a href="global.html#prototypable">prototypable</a></li><li><a href="global.html#writeReportFile">writeReportFile</a></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CrcClass.html">CrcClass</a><ul class='members'><li data-type='member'><a href="CrcClass.html#.nullObject">nullObject</a></li></ul><ul class='methods'><li data-type='method'><a href="CrcClass.html#.create">create</a></li></ul></li><li><a href="CrcCodebase.html">CrcCodebase</a><ul class='methods'><li data-type='method'><a href="CrcCodebase.html#load">load</a></li></ul></li><li><a href="CrcContext.html">CrcContext</a><ul class='members'><li data-type='member'><a href="CrcContext.html#.nullObject">nullObject</a></li></ul><ul class='methods'><li data-type='method'><a href="CrcContext.html#.parse">parse</a></li></ul></li><li><a href="CrcMeta.html">CrcMeta</a><ul class='members'><li data-type='member'><a href="CrcMeta.html#.nullObject">nullObject</a></li></ul></li><li><a href="CrcModel.html">CrcModel</a><ul class='members'><li data-type='member'><a href="CrcModel.html#.nullObject">nullObject</a></li></ul></li><li><a href="CrcReporter.html">CrcReporter</a><ul class='methods'><li data-type='method'><a href="CrcReporter.html#report">report</a></li></ul></li><li><a href="CrcResponsibility.html">CrcResponsibility</a><ul class='methods'><li data-type='method'><a href="CrcResponsibility.html#.create">create</a></li><li data-type='method'><a href="CrcResponsibility.html#.descriptionFromContext">descriptionFromContext</a></li><li data-type='method'><a href="CrcResponsibility.html#valueOf">valueOf</a></li></ul></li><li><a href="EsImgMap.html">EsImgMap</a><ul class='methods'><li data-type='method'><a href="EsImgMap.html#findByDescriptor">findByDescriptor</a></li><li data-type='method'><a href="EsImgMap.html#findByEsVersion">findByEsVersion</a></li><li data-type='method'><a href="EsImgMap.html#toHtmlLinkElemString">toHtmlLinkElemString</a></li></ul></li><li><a href="MdnReference.html">MdnReference</a><ul class='methods'><li data-type='method'><a href="MdnReference.html#get">get</a></li><li data-type='method'><a href="MdnReference.html#link">link</a></li></ul></li><li><a href="NodeManager.html">NodeManager</a><ul class='methods'><li data-type='method'><a href="NodeManager.html#.getAllNodes">getAllNodes</a></li><li data-type='method'><a href="NodeManager.html#.getNamespace">getNamespace</a></li><li data-type='method'><a href="NodeManager.html#.getNodeName">getNodeName</a></li></ul></li><li><a href="NullCrcClass.html">NullCrcClass</a></li><li><a href="NullCrcContext.html">NullCrcContext</a></li><li><a href="NullCrcMeta.html">NullCrcMeta</a></li><li><a href="NullCrcModel.html">NullCrcModel</a></li><li><a href="NullSourceCode.html">NullSourceCode</a></li><li><a href="SourceCodeFactory.html">SourceCodeFactory</a><ul class='members'><li data-type='member'><a href="SourceCodeFactory.html#.nullObject">nullObject</a></li></ul><ul class='methods'><li data-type='method'><a href="SourceCodeFactory.html#.create">create</a></li><li data-type='method'><a href="SourceCodeFactory.html#.parse">parse</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-eslint-plugin-crc.html">eslint-plugin-crc</a></li><li><a href="module-eslint-plugin-crc_crc.html">eslint-plugin-crc/crc</a></li><li><a href="module-eslint-plugin-crc_formatters_md.html">eslint-plugin-crc/formatters/md</a><ul class='methods'><li data-type='method'><a href="module-eslint-plugin-crc_formatters_md.html#~format">format</a></li></ul></li></ul><h3>Interfaces</h3><ul><li><a href="LinkElement.html">LinkElement</a></li></ul><h3>Global</h3><ul><li><a href="global.html#astConfig">astConfig</a></li><li><a href="global.html#copyAssets">copyAssets</a></li><li><a href="global.html#esImgMap">esImgMap</a></li><li><a href="global.html#generateReport">generateReport</a></li><li><a href="global.html#main">main</a></li><li><a href="global.html#options">options</a></li><li><a href="global.html#prototypable">prototypable</a></li><li><a href="global.html#writeReportFile">writeReportFile</a></li></ul>
</nav>

<div id="main">
Expand Down Expand Up @@ -470,7 +470,7 @@ <h4 class="name" id=".nullObject"><span class="type-signature">(static) </span>n

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="crc_crc-class.js.html">crc/crc-class.js</a>, <a href="crc_crc-class.js.html#line115">line 115</a>
<a href="crc_crc-class.js.html">crc/crc-class.js</a>, <a href="crc_crc-class.js.html#line116">line 116</a>
</li></ul></dd>


Expand Down Expand Up @@ -507,13 +507,61 @@ <h4 class="name" id=".nullObject"><span class="type-signature">(static) </span>n



<h5 class="subsection-title">Properties:</h5>



<div class="description">
<p>A CrcClass NullObject.</p>
<table class="props">
<thead>
<tr>

<th>Name</th>


<th>Type</th>





<th class="last">Description</th>
</tr>
</thead>

<tbody>


<tr>

<td class="name"><code>nullObject</code></td>


<td class="type">


<span class="param-type"><a href="NullCrcClass.html">NullCrcClass</a></span>



</td>





<td class="description last"><p>A CrcClass NullObject.</p>
<p>🔒 <strong>Note:</strong> <code>NullCrcClass</code> instances can <strong>only</strong> be created
using the static getter <code>CrcClass.nullObject</code>.</p>
</div>
using the static getter <code>CrcClass.nullObject</code>.</p></td>
</tr>


</tbody>
</table>








Expand Down Expand Up @@ -725,7 +773,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Feb 15 2018 01:20:35 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Feb 18 2018 12:46:59 GMT-0600 (CST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down

0 comments on commit 1453fc2

Please sign in to comment.