Diff: XBee.h

Revision:

1:58a1c083cf8d

Parent:

0:ea8459db49ef

Child:

3:48f7780963e2

--- a/XBee.h	Tue Nov 01 09:04:12 2011 +0000
+++ b/XBee.h	Wed Nov 16 03:37:32 2011 +0000
@@ -35,36 +35,135 @@
  */
 class XBee : public Serial {
 public:
-    /***/
+
+    /**
+     * Frame type declaration for XBee API frames
+     */
     enum FrameType {
+        /**
+        * Empty data
+        */
         None = 0,
+        
+        /**
+         *  AT Command Response API frame
+         */
         ATCommandResponse,
+        
+        /**
+         * Modem Status API frame
+         */
         ModemStatus,
+        
+        /**
+         * ZigBee Transmit Status API frame
+         */
         ZigBeeTransmitStatus,
+        
+
+        /**
+         * ZigBee Receive Packet API frame
+         */
         ZigBeeReceivePacket,
+
+        /**
+         *  ZigBee Explicit Rx Indicator API frame
+         */
         ZigBeeExplicitRxIndicator,
+
+        /**
+         * ZigBee I/O Data Sample Rx Indicator API frame
+         */
         ZigBeeIODataSampleRxIndicator,
+
+        /**
+         * XBee Sensor Read Indicator API frame
+         */
         XBeeSensorReadIndicator,
+
+        /**
+         * Node Identification Indicator API frame
+         */
         NodeIdentificationIndicator,
+
+        /**
+         * Remote Command Response API frame
+         */
         RemoteCommandResponse,
+
+        /**
+         * Unknown API frame
+         */
         Other
     };
-    /***/
+    
+    /**
+     * Value type declarations for retrieving frame data contents
+     */
     enum ValueType {
+    
+        /**
+         * Frame ID
+         */
         FrameID,
+        
+        /**
+         *AT command name
+         */
         ATCommand,
+        
+        /**
+         * Status
+         */       
         Status,
+        
+        /**
+         * Command data
+         */
         CommandData,
+        
+        /**
+         * 16 bit address
+         */
         Address16,
+        
+        /**
+         * 64 bit address
+         */
         Address64,
+        
+        /**
+         * Retry count
+         */
         RetryCount,
+        
+        /**
+         * Delivery status
+         */
         DeliveryStatus,
+        
+        /**
+         * Discovery status
+         */
         DiscoveryStatus,
+        
+        /**
+         * Receive option
+         */
         ReceiveOptions,
+        
+        /**
+         * Received data
+         */
         ReceivedData,
+        
+        /**
+         * Raw data
+         */
         RawData
     };
 
+
     /**
      * creates an XBee interface object.
      *