Cleanup code (#1053)

This patch removes obsolete comments and standardizes header and inline comment placements. The changes primarily involve reordering or removing ESLint disable comments, license header additions or removals, and the deletion of commented out legacy code.

Meanwhile, this patch re-enables `test-raw-pub-sub.js` on Linux platform.

Fix: #1052

Author: minggangw

lib/lifecycle_publisher.js

@@ -37,7 +37,7 @@ class LifecyclePublisher extends Publisher {
    * Publish a message only when activated; otherwise do nothing (nop);
    *
    * @param {object|Buffer} message - The message to be sent, could be kind of JavaScript message generated from .msg
-   *                                                          or be a Buffer for a raw message.
+   *                                  or be a Buffer for a raw message.
    * @returns {undefined}
    */
   publish(message) {

lib/node.js

@@ -1496,7 +1496,7 @@ class Node extends rclnodejs.ShadowNode {
       );
     }
 
-    // publish ParameterEvent
+    // Publish ParameterEvent.
     this._parameterEventPublisher.publish(parameterEvent);
 
     return {

lib/parameter.js

@@ -1,5 +1,3 @@
-/* eslint-disable camelcase */
-
 // Copyright (c) 2020 Wayne Parrott. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,8 +19,9 @@
 
 'use strict';
 
+/* eslint-disable camelcase */
+
 const IsClose = require('is-close');
-const rclnodejs = require('bindings')('rclnodejs');
 
 /**
  * The plus/minus tolerance for determining number equivalence.

lib/parameter_service.js

@@ -27,6 +27,7 @@ const { Parameter, PARAMETER_SEPARATOR } = require('./parameter.js');
  *  rcl_interfaces/srv/GetParameters
  *  rcl_interfaces/srv/SetParameters
  *  rcl_interfaces/srv/SetParametersAtomically
+ *  rcl_interfaces/srv/GetParameterTypes
  *
  * Call start() to begin receiving client request.
  * All service requests are forwarded to the node this service works for.

lib/publisher.js

@@ -38,7 +38,7 @@ class Publisher extends Entity {
   /**
    * Publish a message
    * @param {object|Buffer} message - The message to be sent, could be kind of JavaScript message generated from .msg
-   *                                                          or be a Buffer for a raw message.
+   *                                  or be a Buffer for a raw message.
    * @return {undefined}
    */
   publish(message) {

lib/rate.js

@@ -1,4 +1,3 @@
-//
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at

lib/rmw.js

@@ -1,3 +1,15 @@
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 'use strict';
 
 const DistroUtils = require('./distro');

rosidl_gen/filter.js

@@ -1,3 +1,17 @@
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+'use strict';
+
 const fs = require('fs');
 const path = require('path');
 const os = require('os');

rosidl_gen/message_translator.js

@@ -16,8 +16,6 @@
 
 /* eslint-disable max-depth */
 
-const debug = require('debug')('rclnodejs:message_translator');
-
 function isTypedArray(value) {
   return ArrayBuffer.isView(value) && !(value instanceof DataView);
 }
@@ -39,7 +37,6 @@ function copyMsgObject(msg, obj) {
           // It's an array
           if (typeof obj[i][0] === 'object') {
             // It's an array of objects: converting to ROS message objects
-
             // 1. Extract the element-type first
             // 2. Build the array by translate every elements
             let msgArray = [];
@@ -66,8 +63,7 @@ function copyMsgObject(msg, obj) {
 function verifyMessage(message, obj) {
   if (message.constructor.isROSArray) {
     // It's a ROS message array
-    //  Note: there won't be any JavaScript array in message
-
+    // Note: there won't be any JavaScript array in message.
     if (!Array.isArray(obj)) {
       return false;
     }
@@ -131,7 +127,7 @@ function toPlainObject(message, enableTypedArray = true) {
 
   if (message.constructor.isROSArray) {
     // It's a ROS message array
-    //  Note: there won't be any JavaScript array in message
+    // Note: there won't be any JavaScript array in message.
     let array = [];
     message.data.forEach((e) => {
       array.push(toPlainObject(e, enableTypedArray)); // Translate every elements

rostsd_gen/index.js

@@ -1,6 +1,3 @@
-/* eslint-disable max-depth */
-/* eslint-disable no-sync */
-/* eslint-disable camelcase */
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
@@ -26,6 +23,10 @@ declare module "rclnodejs" {
 }
 */
 
+/* eslint-disable max-depth */
+/* eslint-disable no-sync */
+/* eslint-disable camelcase */
+
 'use strict';
 
 const path = require('path');