Manchester

Files at this revision

API Documentation at this revision

Comitter:
hudakz
Date:
Thu May 18 13:37:21 2017 +0000
Parent:
3:03109c995123
Child:
5:3b2c7e9fda3f
Commit message:
Updated.

Changed in this revision

Manchester.cpp Show annotated file Show diff for this revision Revisions of this file
ManchesterMsg.h Show annotated file Show diff for this revision Revisions of this file
--- a/Manchester.cpp	Thu May 18 10:20:55 2017 +0000
+++ b/Manchester.cpp	Thu May 18 13:37:21 2017 +0000
@@ -42,7 +42,7 @@
         PinName txPin, 
         PinName rxPin, 
         uint32_t speed  /* = 1200 bps */, 
-        uint8_t tol /* = 20% */ 
+        uint8_t tol     /* = 20% */ 
     ) : 
     _tx(txPin), 
     _rx(rxPin) {
@@ -161,8 +161,7 @@
 
 /**
  * @brief   Receives message
- * @note    Waits until a message is received
- *          or receive timeout occured
+ * @note    Waits until a message is received or 'receive timeout' occured
  * @param   msg   Container to store the received message
  * @retval  true  On success
  *          false Otherwise
--- a/ManchesterMsg.h	Thu May 18 10:20:55 2017 +0000
+++ b/ManchesterMsg.h	Thu May 18 13:37:21 2017 +0000
@@ -40,7 +40,7 @@
     char*   data;   // Data field
     size_t  len;    // Length of data in bytes
 
-    /** Creates empty Manchester message of specified capacity.
+    /** Creates empty message of specified capacity.
      */
     ManchesterMsg(size_t max) : _max(max), data(new char[max]) { len = 0; }
 
@@ -58,7 +58,7 @@
      */
     void    clear(void)     { len = 0; memset(data, 0, _max); }
 
-    /** Inserter operator: Appends data (value) to Manchester message
+    /** Inserter operator: Appends data (value) to message
      */
     template<class T>
     ManchesterMsg &operator<<(const T val) {
@@ -75,7 +75,7 @@
         return *this;
     }
 
-    /** Inserter operator: Appends string of char to Manchester message
+    /** Inserter operator: Appends string of char to message
      */
     ManchesterMsg &operator<<(const char* str) {
         size_t  strLen = strlen(str);
@@ -93,7 +93,7 @@
         return *this;
     }
 
-    /** Extractor operator: Extracts data (value) from CAN message
+    /** Extractor operator: Extracts data (value) from message
      */
     template<class T>
     ManchesterMsg &operator>>(T& val) {
@@ -111,7 +111,7 @@
         return *this;
     }
 
-    /** Extractor operator: Extracts string of char from CAN message
+    /** Extractor operator: Extracts string of char from message
      */
     ManchesterMsg &operator>>(char* str) {
         size_t  strLen = strlen(data);