CHENGQI YANG / SmartLabXBeeCore

XBee and XBee-PRO ZigBee RF modules provide cost-effective wireless connectivity to electronic devices. They are interoperable with other ZigBee PRO feature set devices, including devices from other vendors.

Dependencies:   BufferedArray

Dependents:   MBEDminiproject

Diff: Core/APIFrame.h

Revision:
1:3dc0ec2f9fd6
Parent:
0:837e6c48e90d
Child:
3:6b205ec8624b
--- a/Core/APIFrame.h	Thu Oct 22 12:28:26 2015 +0000
+++ b/Core/APIFrame.h	Thu Oct 22 20:02:11 2015 +0000
@@ -3,14 +3,14 @@
 
 #include "BufferedArray.h"
 
+/// An API frame is the structured data sent and received through the serial interface of the radio module when it is configured in API or API escaped operating modes. API frames are used to communicate with the module or with other modules in the network.
 class APIFrame : public BufferedArray
 {
 private:
+    /// Checksum value for the API fram.
     char checkSum;
 
-    /// <summary>
-    /// a state to indicate whether this packet's checksum is verified while process
-    /// </summary>
+    /// A state to indicate whether this packet's checksum is verified while process.
     bool isVerify;
 
 public:
@@ -48,7 +48,8 @@
 
     APIFrame(APIFrame * frame);
 
-    /**
+    /** Get the API frame type.
+    *
     * @returns
     *    Tx64_Request =0x00,
     *    Tx16_Request =0x01,
@@ -114,12 +115,23 @@
     */
     void sets(int position, const char * value, int offset, int length);
 
+    /** Get checksum.
+    * @returns the checksum value
+    */
     char getCheckSum();
 
+    /** Set checksum.
+    * @param value checksum value
+    */
     void setCheckSum(char value);
 
+    /** Check is the API frame's checksum is verified.
+    * @returns true checksum match,
+    *          false checksum not match
+    */
     bool verifyChecksum();
 
+    /// Calculate the checksum value.
     void calculateChecksum();
 };