Updated comments and fixed tabbing

diff --git a/plugins/common/canadapter.h b/plugins/common/canadapter.h
index 0f3a8d5..2efffa0 100644 (file)
--- a/plugins/common/canadapter.h
+++ b/plugins/common/canadapter.h
@@ -80,7 +80,7 @@ public:
      */
     virtual bool registerCyclicMessageForReceive(int canId, double minCycleTime, double maxCycleTime) = 0;
     /**
-     * Unregisters CAN ID for receiving
+     * Un-registers CAN ID of a message used of receiving. Valid for cyclic and sporadic messages.
      * @fn unregisterMessageForReceive
      * @param canId CAN ID of the message.
      * @return True if de-registration succeeds.

diff --git a/plugins/common/canbus.h b/plugins/common/canbus.h
index 0627de6..4d9d856 100644 (file)
--- a/plugins/common/canbus.h
+++ b/plugins/common/canbus.h
@@ -39,7 +39,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 class CANBus
 {
 public:
-       virtual ~CANBus(){} /*LCOV_EXCL_LINE*/
+    virtual ~CANBus(){} /*LCOV_EXCL_LINE*/
 
     /**
     * Starts the CAN bus instance on the specified interface
@@ -47,26 +47,26 @@ public:
     * @param name Name of the CAN bus network interface
     * @return True if no error occurs.
     */
-       virtual bool start(const char* name) = 0;
+    virtual bool start(const char* name) = 0;
     /**
     * Stops the CAN bus instance
     * @fn stop
     */
-       virtual void stop() = 0; 
+    virtual void stop() = 0; 
     /**
     * Sends standard(11bit) CAN frame over the bus
     * @fn sendStandardFrame
     * @param frame CAN frame to be sent
     * @return True if frame was sent
     */
-       virtual bool sendStandardFrame(const can_frame& frame) = 0;
+    virtual bool sendStandardFrame(const can_frame& frame) = 0;
     /**
     * Sends extended(29bit) CAN frame over the bus
     * @fn sendExtendedFrame
     * @param frame CAN frame to be sent
     * @return True if frame was sent
     */
-       virtual bool sendExtendedFrame(const can_frame& frame) = 0;
+    virtual bool sendExtendedFrame(const can_frame& frame) = 0;
     /**
     * Registers CAN ID of a cyclic message for receiving
     * @fn registerCyclicMessageForReceive
@@ -84,10 +84,10 @@ public:
     */
     virtual bool registerMessageForReceive(int canId)
     {
-        return registerCyclicMessageForReceive(canId, 0, 0);
+       return registerCyclicMessageForReceive(canId, 0, 0);
     }
     /**
-    * Unregisters CAN ID for receiving
+    * Un-registers CAN ID of a message used of receiving. Valid for cyclic and sporadic messages.
     * @fn unregisterMessageForReceive
     * @param canId CAN ID of the message.
     * @return True if de-registration succeeds.

diff --git a/plugins/common/canbusimpl.h b/plugins/common/canbusimpl.h
index f8dcd20..c7698b8 100644 (file)
--- a/plugins/common/canbusimpl.h
+++ b/plugins/common/canbusimpl.h
@@ -82,7 +82,7 @@ public:
      */
     virtual bool registerCyclicMessageForReceive(int canId, double minCycleTime, double maxCycleTime);
     /**
-     * Unregisters CAN ID for receiving
+     * Un-registers CAN ID of a message used of receiving. Valid for cyclic and sporadic messages.
      * @fn unregisterMessageForReceive
      * @param canId CAN ID of the message.
      * @return True if de-registration succeeds.

diff --git a/plugins/common/cansocket.h b/plugins/common/cansocket.h
index 44dd8f4..a201e5a 100644 (file)
--- a/plugins/common/cansocket.h
+++ b/plugins/common/cansocket.h
@@ -89,7 +89,7 @@ public:
      */
     virtual bool registerCyclicMessageForReceive(int canId, double minCycleTime, double maxCycleTime);
     /**
-     * Unregisters CAN ID for receiving
+     * Un-registers CAN ID of a message used of receiving. Valid for cyclic and sporadic messages.
      * @fn unregisterMessageForReceive
      * @param canId CAN ID of the message.
      * @return True if de-registration succeeds.

diff --git a/plugins/common/cansocketadapter.h b/plugins/common/cansocketadapter.h
index 3c8e46f..334e523 100644 (file)
--- a/plugins/common/cansocketadapter.h
+++ b/plugins/common/cansocketadapter.h
@@ -73,7 +73,7 @@ public:
     */
     virtual bool registerCyclicMessageForReceive(int canId, double minCycleTime, double maxCycleTime);
     /**
-    * Unregisters CAN ID for receiving
+    * Un-registers CAN ID of a message used of receiving. Valid for cyclic and sporadic messages.
     * @fn unregisterMessageForReceive
     * @param canId CAN ID of the message.
     * @return True if de-registration succeeds.