Merge pull request RobotWebTools#195 from Rayman/fix-jsdoc

Fix JSDoc
Rayman · Sep 8, 2015 · cafd9b9 · cafd9b9
2 parents 5306d8d + 359a8d3
commit cafd9b9
Show file tree

Hide file tree

Showing 30 changed files with 44 additions and 2 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -90,7 +90,8 @@ module.exports = function(grunt) {
           './src/**/*.js'
         ],
         options: {
-          destination: './doc'
+          destination: './doc',
+          private: false
         }
       }
     }

diff --git a/src/RosLib.js b/src/RosLib.js
@@ -1,7 +1,13 @@
 /**
+ * @fileOverview
  * @author Russell Toris - rctoris@wpi.edu
  */
 
+/**
+ * If you use roslib in a browser, all the classes will be exported to a global variable called ROSLIB.
+ *
+ * If you use nodejs, this is the variable you get when you require('roslib')
+ */
 var ROSLIB = this.ROSLIB || {
   REVISION : '0.18.0-SNAPSHOT'
 };

diff --git a/src/RosLibNode.js b/src/RosLibNode.js
@@ -1,5 +1,5 @@
 /**
- * ROSLIB Node exclusive extensions 
+ * @fileOverview ROSLIB Node exclusive extensions 
  */
 var assign = require('object-assign');
 

diff --git a/src/actionlib/ActionClient.js b/src/actionlib/ActionClient.js
@@ -1,4 +1,5 @@
 /**
+ * @fileOverview
  * @author Russell Toris - rctoris@wpi.edu
  */
 

diff --git a/src/actionlib/Goal.js b/src/actionlib/Goal.js
@@ -1,4 +1,5 @@
 /**
+ * @fileOverview
  * @author Russell Toris - rctoris@wpi.edu
  */
 

diff --git a/src/actionlib/SimpleActionServer.js b/src/actionlib/SimpleActionServer.js
@@ -1,4 +1,5 @@
 /**
+ * @fileOverview
  * @author Laura Lindzey - lindzey@gmail.com
  */
 

diff --git a/src/core/Message.js b/src/core/Message.js
@@ -1,4 +1,5 @@
 /**
+ * @fileoverview
  * @author Brandon Alexander - baalexander@gmail.com
  */
 

diff --git a/src/core/Param.js b/src/core/Param.js
@@ -1,4 +1,5 @@
 /**
+ * @fileoverview
  * @author Brandon Alexander - baalexander@gmail.com
  */
 

diff --git a/src/core/Ros.js b/src/core/Ros.js
@@ -1,4 +1,5 @@
 /**
+ * @fileoverview
  * @author Brandon Alexander - baalexander@gmail.com
  */
 

diff --git a/src/core/Service.js b/src/core/Service.js
@@ -1,4 +1,5 @@
 /**
+ * @fileoverview
  * @author Brandon Alexander - baalexander@gmail.com
  */
 

diff --git a/src/core/ServiceRequest.js b/src/core/ServiceRequest.js
@@ -1,4 +1,5 @@
 /**
+ * @fileoverview
  * @author Brandon Alexander - balexander@willowgarage.com
  */
 

diff --git a/src/core/ServiceResponse.js b/src/core/ServiceResponse.js
@@ -1,4 +1,5 @@
 /**
+ * @fileoverview
  * @author Brandon Alexander - balexander@willowgarage.com
  */
 

diff --git a/src/core/SocketAdapter.js b/src/core/SocketAdapter.js
@@ -4,6 +4,7 @@
  *
  * Note to anyone reviewing this code: these functions are called
  * in the context of their parent object, unless bound
+ * @fileOverview
  */
 'use strict';
 
@@ -20,6 +21,7 @@ if(typeof bson !== 'undefined'){
  * gzipping over WebSockets * is not supported yet), this function places the
  * "image" in a canvas element then decodes the * "image" as a Base64 string.
  *
+ * @private
  * @param data - object containing the PNG data.
  * @param callback - function with params:
  *   * data - the uncompressed data
@@ -63,6 +65,9 @@ function decompressPng(data, callback) {
  * Events listeners for a WebSocket or TCP socket to a JavaScript
  * ROS Client. Sets up Messages for a given topic to trigger an
  * event on the ROS client.
+ * 
+ * @namespace SocketAdapter
+ * @private
  */
 function SocketAdapter(client) {
   function handleMessage(message) {
@@ -78,6 +83,7 @@ function SocketAdapter(client) {
      * Emits a 'connection' event on WebSocket connection.
      *
      * @param event - the argument to emit with the event.
+     * @memberof SocketAdapter
      */
     onopen: function onOpen(event) {
       client.isConnected = true;
@@ -88,6 +94,7 @@ function SocketAdapter(client) {
      * Emits a 'close' event on WebSocket disconnection.
      *
      * @param event - the argument to emit with the event.
+     * @memberof SocketAdapter
      */
     onclose: function onClose(event) {
       client.isConnected = false;
@@ -98,6 +105,7 @@ function SocketAdapter(client) {
      * Emits an 'error' event whenever there was an error.
      *
      * @param event - the argument to emit with the event.
+     * @memberof SocketAdapter
      */
     onerror: function onError(event) {
       client.emit('error', event);
@@ -108,6 +116,7 @@ function SocketAdapter(client) {
      * topic, service, or param.
      *
      * @param message - the raw JSON message from rosbridge.
+     * @memberof SocketAdapter
      */
     onmessage: function onMessage(message) {
       if(typeof Blob !== 'undefined' && message.data instanceof Blob) {

diff --git a/src/core/Topic.js b/src/core/Topic.js
@@ -1,4 +1,5 @@
 /**
+ * @fileoverview
  * @author Brandon Alexander - baalexander@gmail.com
  */
 

diff --git a/src/math/Pose.js b/src/math/Pose.js
@@ -1,4 +1,5 @@
 /**
+ * @fileoverview
  * @author David Gossow - dgossow@willowgarage.com
  */
 

diff --git a/src/math/Quaternion.js b/src/math/Quaternion.js
@@ -1,4 +1,5 @@
 /**
+ * @fileoverview
  * @author David Gossow - dgossow@willowgarage.com
  */
 

diff --git a/src/math/Transform.js b/src/math/Transform.js
@@ -1,4 +1,5 @@
 /**
+ * @fileoverview
  * @author David Gossow - dgossow@willowgarage.com
  */
 

diff --git a/src/math/Vector3.js b/src/math/Vector3.js
@@ -1,4 +1,5 @@
 /**
+ * @fileoverview
  * @author David Gossow - dgossow@willowgarage.com
  */
 

diff --git a/src/node/RosTCP.js b/src/node/RosTCP.js
@@ -5,6 +5,7 @@ var util = require('util');
 
 /**
  * Same as core Ros except supports TCP connections
+ * @private
  */ 
 function RosTCP(options) {
   options = options || {};

diff --git a/src/tf/TFClient.js b/src/tf/TFClient.js
@@ -1,4 +1,5 @@
 /**
+ * @fileoverview
  * @author David Gossow - dgossow@willowgarage.com
  */
 

diff --git a/src/urdf/UrdfBox.js b/src/urdf/UrdfBox.js
@@ -1,4 +1,5 @@
 /**
+ * @fileOverview 
  * @author Benjamin Pitzer - ben.pitzer@gmail.com
  * @author Russell Toris - rctoris@wpi.edu
  */

diff --git a/src/urdf/UrdfColor.js b/src/urdf/UrdfColor.js
@@ -1,4 +1,5 @@
 /**
+ * @fileOverview 
  * @author Benjamin Pitzer - ben.pitzer@gmail.com
  * @author Russell Toris - rctoris@wpi.edu
  */

diff --git a/src/urdf/UrdfCylinder.js b/src/urdf/UrdfCylinder.js
@@ -1,4 +1,5 @@
 /**
+ * @fileOverview 
  * @author Benjamin Pitzer - ben.pitzer@gmail.com
  * @author Russell Toris - rctoris@wpi.edu
  */

diff --git a/src/urdf/UrdfJoint.js b/src/urdf/UrdfJoint.js
@@ -1,4 +1,5 @@
 /**
+ * @fileOverview 
  * @author David V. Lu!!  davidvlu@gmail.com
  */
 

diff --git a/src/urdf/UrdfLink.js b/src/urdf/UrdfLink.js
@@ -1,4 +1,5 @@
 /**
+ * @fileOverview 
  * @author Benjamin Pitzer - ben.pitzer@gmail.com
  * @author Russell Toris - rctoris@wpi.edu
  */

diff --git a/src/urdf/UrdfMaterial.js b/src/urdf/UrdfMaterial.js
@@ -1,4 +1,5 @@
 /**
+ * @fileOverview 
  * @author Benjamin Pitzer - ben.pitzer@gmail.com
  * @author Russell Toris - rctoris@wpi.edu
  */

diff --git a/src/urdf/UrdfMesh.js b/src/urdf/UrdfMesh.js
@@ -1,4 +1,5 @@
 /**
+ * @fileOverview 
  * @author Benjamin Pitzer - ben.pitzer@gmail.com
  * @author Russell Toris - rctoris@wpi.edu
  */

diff --git a/src/urdf/UrdfModel.js b/src/urdf/UrdfModel.js
@@ -1,4 +1,5 @@
 /**
+ * @fileOverview 
  * @author Benjamin Pitzer - ben.pitzer@gmail.com
  * @author Russell Toris - rctoris@wpi.edu
  */

diff --git a/src/urdf/UrdfSphere.js b/src/urdf/UrdfSphere.js
@@ -1,4 +1,5 @@
 /**
+ * @fileOverview 
  * @author Benjamin Pitzer - ben.pitzer@gmail.com
  * @author Russell Toris - rctoris@wpi.edu
  */

diff --git a/src/urdf/UrdfVisual.js b/src/urdf/UrdfVisual.js
@@ -1,4 +1,5 @@
 /**
+ * @fileOverview 
  * @author Benjamin Pitzer - ben.pitzer@gmail.com
  * @author Russell Toris - rctoris@wpi.edu
  */