Remove 'An object with the following keys'

Author: MatthijsBurgh

src/actionlib/ActionClient.js

@@ -17,7 +17,7 @@ var EventEmitter2 = require('eventemitter2').EventEmitter2;
  *  * 'result' - The result returned from the action server.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Ros} options.ros - The ROSLIB.Ros connection handle.
  * @param {string} options.serverName - The action server name, like '/fibonacci'.
  * @param {string} options.actionName - The action message name, like 'actionlib_tutorials/FibonacciAction'.

src/actionlib/ActionListener.js

@@ -17,7 +17,7 @@ var EventEmitter2 = require('eventemitter2').EventEmitter2;
  *  * 'result' - The result returned from the action server.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Ros} options.ros - The ROSLIB.Ros connection handle.
  * @param {string} options.serverName - The action server name, like '/fibonacci'.
  * @param {string} options.actionName - The action message name, like 'actionlib_tutorials/FibonacciAction'.

src/actionlib/Goal.js

@@ -13,7 +13,7 @@ var EventEmitter2 = require('eventemitter2').EventEmitter2;
  *  * 'timeout' - If a timeout occurred while sending a goal.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {ActionClient} options.actionClient - The ROSLIB.ActionClient to use with this goal.
  * @param {Object} options.goalMessage - The JSON object containing the goal for the action server.
  */
@@ -86,4 +86,4 @@ Goal.prototype.cancel = function() {
   this.actionClient.cancelTopic.publish(cancelMessage);
 };
 
-module.exports = Goal;
+module.exports = Goal;

src/actionlib/SimpleActionServer.js

@@ -15,7 +15,7 @@ var EventEmitter2 = require('eventemitter2').EventEmitter2;
  *  * 'cancel' - Action client has canceled the request.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Ros} options.ros - The ROSLIB.Ros connection handle.
  * @param {string} options.serverName - The action server name, like '/fibonacci'.
  * @param {string} options.actionName - The action message name, like 'actionlib_tutorials/FibonacciAction'.
@@ -76,7 +76,7 @@ function SimpleActionServer(options) {
     this.nextGoal = null; // the one that'll be preempting
 
     goalListener.subscribe(function(goalMessage) {
-        
+
     if(that.currentGoal) {
             that.nextGoal = goalMessage;
             // needs to happen AFTER rest is set up
@@ -222,4 +222,4 @@ SimpleActionServer.prototype.setPreempted = function() {
     }
 };
 
-module.exports = SimpleActionServer;
+module.exports = SimpleActionServer;

src/core/Param.js

@@ -10,7 +10,7 @@ var ServiceRequest = require('./ServiceRequest');
  * A ROS parameter.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Ros} options.ros - The ROSLIB.Ros connection handle.
  * @param {string} options.name - The param name, like max_vel_x.
  */
@@ -66,7 +66,7 @@ Param.prototype.set = function(value, callback) {
 
 /**
  * Delete this parameter on the ROS server.
- * 
+ *
  * @param {function} callback - The callback function.
  */
 Param.prototype.delete = function(callback) {
@@ -83,4 +83,4 @@ Param.prototype.delete = function(callback) {
   paramClient.callService(request, callback);
 };
 
-module.exports = Param;
+module.exports = Param;

src/core/Ros.js

@@ -24,7 +24,7 @@ var EventEmitter2 = require('eventemitter2').EventEmitter2;
  *  * <serviceID> - A service response came from rosbridge with the given ID.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {string} [options.url] - The WebSocket URL for rosbridge or the node server URL to connect using socket.io (if socket.io exists in the page). Can be specified later with `connect`.
  * @param {boolean} [options.groovyCompatibility] - Don't use interfaces that changed after the last groovy release or rosbridge_suite and related tools (defaults to true).
  * @param {string} [options.transportLibrary] - One of 'websocket', 'workersocket' (default), 'socket.io' or RTCPeerConnection instance controlling how the connection is created in `connect`.
@@ -459,13 +459,13 @@ Ros.prototype.getNodes = function(callback, failedCallback) {
  * @param {string[]} callback.services - Array of service names hosted.
  * @param {function} [failedCallback] - The callback function when the service call failed with params:
  * @param {string} failedCallback.error - The error message reported by ROS.
- * 
+ *
  * @also
- * 
+ *
  * Retrieve a list of subscribed topics, publishing topics and services of a specific node.
  * <br>
  * These are the parameters if failedCallback is <strong>undefined</strong>.
- * 
+ *
  * @param {string} node - Name of the node.
  * @param {function} callback - Function with the following params:
  * @param {Object} callback.result - The result object with the following params:

src/core/Service.js

@@ -11,7 +11,7 @@ var EventEmitter2 = require('eventemitter2').EventEmitter2;
  * A ROS service client.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Ros} options.ros - The ROSLIB.Ros connection handle.
  * @param {string} options.name - The service name, like '/add_two_ints'.
  * @param {string} options.serviceType - The service type, like 'rospy_tutorials/AddTwoInts'.

src/core/Topic.js

@@ -14,7 +14,7 @@ var Message = require('./Message');
  *  * 'message' - The message data from rosbridge.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Ros} options.ros - The ROSLIB.Ros connection handle.
  * @param {string} options.name - The topic name, like '/cmd_vel'.
  * @param {string} options.messageType - The message type, like 'std_msgs/String'.

src/math/Pose.js

@@ -10,7 +10,7 @@ var Quaternion = require('./Quaternion');
  * A Pose in 3D space. Values are copied into this object.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Vector3} options.position - The ROSLIB.Vector3 describing the position.
  * @param {Quaternion} options.orientation - The ROSLIB.Quaternion describing the orientation.
  */
@@ -69,4 +69,4 @@ Pose.prototype.getInverse = function() {
   return inverse;
 };
 
-module.exports = Pose;
+module.exports = Pose;

src/math/Quaternion.js

@@ -7,7 +7,7 @@
  * A Quaternion.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {number} [options.x] - The x value (defaults to 0).
  * @param {number} [options.y] - The y value (defaults to 0).
  * @param {number} [options.z] - The z value (defaults to 0).

src/math/Transform.js

@@ -10,7 +10,7 @@ var Quaternion = require('./Quaternion');
  * A Transform in 3-space. Values are copied into this object.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Vector3} options.translation - The ROSLIB.Vector3 describing the translation.
  * @param {Quaternion} options.rotation - The ROSLIB.Quaternion describing the rotation.
  */
@@ -30,4 +30,4 @@ Transform.prototype.clone = function() {
   return new Transform(this);
 };
 
-module.exports = Transform;
+module.exports = Transform;

src/math/Vector3.js

@@ -7,7 +7,7 @@
  * A 3D vector.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {number} [options.x] - The x value (defaults to 0).
  * @param {number} [options.y] - The y value (defaults to 0).
  * @param {number} [options.z] - The z value (defaults to 0).
@@ -65,4 +65,4 @@ Vector3.prototype.clone = function() {
   return new Vector3(this);
 };
 
-module.exports = Vector3;
+module.exports = Vector3;

src/node/TopicStream.js

@@ -6,7 +6,7 @@ var DuplexStream = require('stream').Duplex;
  * stream. This stream can be piped to, which will
  * publish to the topic.
  *
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {boolean} [options.subscribe] - The flag to indicate whether to subscribe to the topic and start emitting data or not (defaults to true).
  * @param {boolean} [options.publish] - The flag to indicate whether to register the stream as a publisher to the topic or not (defaults to true).
  * @param {boolean} [options.transform] - A function to change the data to be published or filter it if false is returned.
@@ -21,7 +21,7 @@ Topic.prototype.toStream = function(options) {
         objectMode: true
     });
     stream._read = function() {};
-    
+
     // Publish to the topic if someone pipes to stream
     stream._write = function(chunk, encoding, callback) {
         if (hasTransform) {
@@ -32,7 +32,7 @@ Topic.prototype.toStream = function(options) {
         }
         callback();
     };
-    
+
     if (options.subscribe) {
         this.subscribe(function(message) {
             stream.push(message);
@@ -47,4 +47,4 @@ Topic.prototype.toStream = function(options) {
     return stream;
 };
 
-module.exports = Topic;
+module.exports = Topic;

src/tf/TFClient.js

@@ -16,7 +16,7 @@ var Transform = require('../math/Transform');
  * A TF Client that listens to TFs from tf2_web_republisher.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Ros} options.ros - The ROSLIB.Ros connection handle.
  * @param {string} options.fixedFrame - The fixed frame, like '/base_link'.
  * @param {number} options.angularThres - The angular threshold for the TF republisher (defaults to 2.0).

src/urdf/UrdfBox.js

@@ -11,7 +11,7 @@ var UrdfTypes = require('./UrdfTypes');
  * A Box element in a URDF.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Element} options.xml - The XML element to parse.
  */
 function UrdfBox(options) {
@@ -27,4 +27,4 @@ function UrdfBox(options) {
   });
 }
 
-module.exports = UrdfBox;
+module.exports = UrdfBox;

src/urdf/UrdfColor.js

@@ -8,7 +8,7 @@
  * A Color element in a URDF.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Element} options.xml - The XML element to parse.
  */
 function UrdfColor(options) {
@@ -20,4 +20,4 @@ function UrdfColor(options) {
   this.a = parseFloat(rgba[3]);
 }
 
-module.exports = UrdfColor;
+module.exports = UrdfColor;

src/urdf/UrdfCylinder.js

@@ -10,7 +10,7 @@ var UrdfTypes = require('./UrdfTypes');
  * A Cylinder element in a URDF.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Element} options.xml - The XML element to parse.
  */
 function UrdfCylinder(options) {
@@ -19,4 +19,4 @@ function UrdfCylinder(options) {
   this.radius = parseFloat(options.xml.getAttribute('radius'));
 }
 
-module.exports = UrdfCylinder;
+module.exports = UrdfCylinder;

src/urdf/UrdfJoint.js

@@ -11,7 +11,7 @@ var Quaternion = require('../math/Quaternion');
  * A Joint element in a URDF.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Element} options.xml - The XML element to parse.
  */
 function UrdfJoint(options) {

src/urdf/UrdfLink.js

@@ -10,7 +10,7 @@ var UrdfVisual = require('./UrdfVisual');
  * A Link element in a URDF.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Element} options.xml - The XML element to parse.
  */
 function UrdfLink(options) {
@@ -25,4 +25,4 @@ function UrdfLink(options) {
   }
 }
 
-module.exports = UrdfLink;
+module.exports = UrdfLink;

src/urdf/UrdfMaterial.js

@@ -10,7 +10,7 @@ var UrdfColor = require('./UrdfColor');
  * A Material element in a URDF.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Element} options.xml - The XML element to parse.
  */
 function UrdfMaterial(options) {

src/urdf/UrdfMesh.js

@@ -11,7 +11,7 @@ var UrdfTypes = require('./UrdfTypes');
  * A Mesh element in a URDF.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Element} options.xml - The XML element to parse.
  */
 function UrdfMesh(options) {
@@ -33,4 +33,4 @@ function UrdfMesh(options) {
   }
 }
 
-module.exports = UrdfMesh;
+module.exports = UrdfMesh;

src/urdf/UrdfModel.js

@@ -16,7 +16,7 @@ var XPATH_FIRST_ORDERED_NODE_TYPE = 9;
  * A URDF Model can be used to parse a given URDF into the appropriate elements.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Element} options.xml - The XML element to parse.
  * @param {string} options.string - The XML element to parse as a string.
  */

src/urdf/UrdfSphere.js

@@ -10,12 +10,12 @@ var UrdfTypes = require('./UrdfTypes');
  * A Sphere element in a URDF.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Element} options.xml - The XML element to parse.
  */
 function UrdfSphere(options) {
   this.type = UrdfTypes.URDF_SPHERE;
   this.radius = parseFloat(options.xml.getAttribute('radius'));
 }
 
-module.exports = UrdfSphere;
+module.exports = UrdfSphere;

src/urdf/UrdfVisual.js

@@ -18,7 +18,7 @@ var UrdfSphere = require('./UrdfSphere');
  * A Visual element in a URDF.
  *
  * @constructor
- * @param {Object} options - An object with the following keys:
+ * @param {Object} options
  * @param {Element} options.xml - The XML element to parse.
  */
 function UrdfVisual(options) {
@@ -127,4 +127,4 @@ function UrdfVisual(options) {
   }
 }
 
-module.exports = UrdfVisual;
+module.exports = UrdfVisual;