Skip to content

Commit

Permalink
0.12.0 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rctoris committed Feb 4, 2015
1 parent c080cb6 commit dbe0d72
Show file tree
Hide file tree
Showing 55 changed files with 139 additions and 303 deletions.
2 changes: 1 addition & 1 deletion doc/ActionClient.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Goal.html
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Goal.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Message.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Param.html
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Param.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Pose.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Quaternion.html
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Quaternion.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
29 changes: 14 additions & 15 deletions doc/Ros.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,7 @@ <h5>Parameters:</h5>


<td class="description last">possible keys include:
* url (optional) - the WebSocket URL for rosbridge (can be specified later with `connect`)
* groovyCompatibility - don't use interfaces that changed after the last groovy release or rosbridge_suite and related tools (defaults to true)</td>
* url (optional) - the WebSocket URL for rosbridge (can be specified later with `connect`)</td>
</tr>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line29">line 29</a>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line28">line 28</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line82">line 82</a>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line74">line 74</a>
</li></ul></dd>


Expand Down Expand Up @@ -446,7 +445,7 @@ <h4 class="name" id="callOnConnection"><span class="type-signature"></span>callO

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line102">line 102</a>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line94">line 94</a>
</li></ul></dd>


Expand Down Expand Up @@ -517,7 +516,7 @@ <h4 class="name" id="close"><span class="type-signature"></span>close<span class

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line65">line 65</a>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line57">line 57</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line58">line 58</a>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line50">line 50</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line240">line 240</a>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line232">line 232</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line221">line 221</a>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line213">line 213</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line161">line 161</a>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line153">line 153</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line181">line 181</a>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line173">line 173</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line141">line 141</a>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line133">line 133</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line121">line 121</a>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line113">line 113</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line200">line 200</a>
<a href="Ros.js.html">core/Ros.js</a>, <a href="Ros.js.html#line192">line 192</a>
</li></ul></dd>


Expand Down Expand Up @@ -1502,7 +1501,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
10 changes: 1 addition & 9 deletions doc/Ros.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,21 +51,13 @@ <h1 class="page-title">Source: core/Ros.js</h1>
* @constructor
* @param options - possible keys include:
* * url (optional) - the WebSocket URL for rosbridge (can be specified later with `connect`)
* * groovyCompatibility - don't use interfaces that changed after the last groovy release or rosbridge_suite and related tools (defaults to true)
*/
function Ros(options) {
options = options || {};
this.socket = null;
this.idCounter = 0;
this.isConnected = false;

if (typeof options.groovyCompatibility === 'undefined') {
this.groovyCompatibility = true;
}
else {
this.groovyCompatibility = options.groovyCompatibility;
}

// Sets unlimited event listeners.
this.setMaxListeners(0);

Expand Down Expand Up @@ -329,7 +321,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
4 changes: 2 additions & 2 deletions doc/RosLib.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ <h1 class="page-title">Source: RosLib.js</h1>
*/

var ROSLIB = this.ROSLIB || {
REVISION : '0.11.0'
REVISION : '0.12.0'
};

var Ros = ROSLIB.Ros = require('./core/Ros');
Expand Down Expand Up @@ -90,7 +90,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/RosLibNode.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/RosTCP.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Service.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/ServiceRequest.html
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/ServiceRequest.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/ServiceResponse.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/SimpleActionServer.html
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/SimpleActionServer.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/SocketAdapter.js.html
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="global.h
<br clear="both">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 09:12:20 GMT-0500 (EST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Wed Feb 04 2015 11:42:55 GMT-0500 (EST)
</footer>

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

0 comments on commit dbe0d72

Please sign in to comment.