Skip to content

Commit

Permalink
docs: regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
reconbot committed Jun 25, 2018
1 parent f2285d0 commit eb053db
Show file tree
Hide file tree
Showing 18 changed files with 38 additions and 26 deletions.
2 changes: 1 addition & 1 deletion docs/BaseBinding.html
Original file line number Diff line number Diff line change
Expand Up @@ -2367,7 +2367,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:31 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/DarwinBinding.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ <h4 class="name" id="DarwinBinding"><span class="type-signature"></span>new Darw
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:31 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/LinuxBinding.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ <h4 class="name" id="LinuxBinding"><span class="type-signature"></span>new Linux
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:32 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/MockBinding.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ <h4 class="name" id="MockBinding"><span class="type-signature"></span>new MockBi
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:32 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/Poller.html
Original file line number Diff line number Diff line change
Expand Up @@ -576,7 +576,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:32 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/SerialPort.html
Original file line number Diff line number Diff line change
Expand Up @@ -2961,7 +2961,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:32 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/WindowsBinding.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ <h4 class="name" id="WindowsBinding"><span class="type-signature"></span>new Win
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:32 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/bindings_base.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ <h1 class="page-title">bindings/base.js</h1>
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:31 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
3 changes: 2 additions & 1 deletion docs/bindings_darwin.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ <h1 class="page-title">bindings/darwin.js</h1>
.then(() => {
const fd = this.fd;
this.poller.stop();
this.poller.destroy();
this.poller = null;
this.openOptions = null;
this.fd = null;
Expand Down Expand Up @@ -160,7 +161,7 @@ <h1 class="page-title">bindings/darwin.js</h1>
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:31 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
3 changes: 2 additions & 1 deletion docs/bindings_linux.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ <h1 class="page-title">bindings/linux.js</h1>
.then(() => {
const fd = this.fd;
this.poller.stop();
this.poller.destroy();
this.poller = null;
this.openOptions = null;
this.fd = null;
Expand Down Expand Up @@ -160,7 +161,7 @@ <h1 class="page-title">bindings/linux.js</h1>
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:31 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/bindings_mock.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ <h1 class="page-title">bindings/mock.js</h1>
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:31 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
12 changes: 11 additions & 1 deletion docs/bindings_poller.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,16 @@ <h1 class="page-title">bindings/poller.js</h1>
stop() {
logger('Stopping poller');
this.poller.stop();
this.emitCanceled();
}

destroy() {
logger('Destroying poller');
this.poller.destroy();
this.emitCanceled();
}

emitCanceled() {
const err = new Error('Canceled');
err.canceled = true;
this.emit('readable', err);
Expand All @@ -159,7 +169,7 @@ <h1 class="page-title">bindings/poller.js</h1>
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:31 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/bindings_win32.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ <h1 class="page-title">bindings/win32.js</h1>
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:31 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/global.html
Original file line number Diff line number Diff line change
Expand Up @@ -2100,7 +2100,7 @@ <h4 class="name" id="event:open">open</h4>
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:31 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
6 changes: 3 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,15 @@ <h2>Intro to Node-Serialport</h2><p>Imagine a world where you can write JavaScri
<p>We're not against firmware but we're better than it.</p>
<h2>Quick Answers to Important Questions</h2><ul>
<li><a href="https://node-serialport.github.io/node-serialport/"><strong>API Docs</strong></a></li>
<li><a href="https://node-serialport.github.io/parsers/">Parsers API Docs</a></li>
<li><a href="https://node-serialport.github.io/utilities/">Parsers API Docs</a></li>
<li><strong>For support</strong>, open a <a href="https://github.com/node-serialport/node-serialport/issues/new">GitHub issue</a>.</li>
<li><strong>For discussions, design ideas, and clarifications</strong>, please join our <a href="https://gitter.im/EmergingTechnologyAdvisors/node-serialport">Gitter chat room</a>.</li>
<li><strong>To contribute</strong>, please review our <a href="CONTRIBUTING.md">contribution guide</a> and <a href="CODE_OF_CONDUCT.md">Code of Conduct</a>. You might want to check out our <a href="https://github.com/node-serialport/node-serialport/issues/746">roadmap</a>. We also have issues tagged <a href="https://github.com/node-serialport/node-serialport/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+pr%22">&quot;good first PR&quot;</a>, if you'd like to start somewhere specific. We'll do our best to support you until we merge your PR.</li>
</ul>
<hr>
<h2>API Documentation</h2><ul>
<li><a href="https://node-serialport.github.io/node-serialport/"><strong>API Docs</strong></a></li>
<li><a href="https://node-serialport.github.io/parsers/">Parsers API Docs</a></li>
<li><a href="https://node-serialport.github.io/utilities/">Parsers API Docs</a></li>
</ul>
<p>See our <a href="CHANGELOG.md">changelog</a> for what's new, and our <a href="UPGRADE_GUIDE.md">upgrade guide</a> for a walk-through on differences between major versions.</p>
<p>Older versions are no longer supported but their docs can be found by looking through release tags.</p>
Expand Down Expand Up @@ -490,7 +490,7 @@ <h3>Serial Port List</h3><p><code>serialport-list</code> will list all available
<br class="clear">

<footer>
Documentation generated at Sun May 06 2018 01:37:34 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ <h1 class="page-title">index.js</h1>
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:31 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
14 changes: 7 additions & 7 deletions docs/parsers.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,12 @@ <h1 class="page-title">parsers.js</h1>
*/

module.exports = {
ByteLength: require('parser-byte-length'),
CCTalk: require('parser-cctalk'),
Delimiter: require('parser-delimiter'),
Readline: require('parser-readline'),
Ready: require('parser-ready'),
Regex: require('parser-regex')
ByteLength: require('@serialport/parser-byte-length'),
CCTalk: require('@serialport/parser-cctalk'),
Delimiter: require('@serialport/parser-delimiter'),
Readline: require('@serialport/parser-readline'),
Ready: require('@serialport/parser-ready'),
Regex: require('@serialport/parser-regex')
};
</code></pre>
</article>
Expand All @@ -93,7 +93,7 @@ <h1 class="page-title">parsers.js</h1>
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:31 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/serialport.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -692,7 +692,7 @@ <h1 class="page-title">serialport.js</h1>
<br class="clear">

<footer>
Documentation generated at Sun Apr 15 2018 22:06:31 GMT-0400 (EDT)
Documentation generated at Mon Jun 25 2018 03:04:41 GMT-0400 (EDT)
</footer>

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

0 comments on commit eb053db

Please sign in to comment.