John Bailey / XBeeApi

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   CircularBuffer FixedLengthList

Dependents:   XBeeApiTest XBeeApiSimpleATCmdsExample XBeeApiBroadcastExample XBeeApiBroadcastExampleRTOS ... more

Diff: RXTX/XBeeApiRxFrameCircularBuffer.hpp

Revision:
53:7b65422d7a32
Parent:
47:5d3608835668
--- a/RXTX/XBeeApiRxFrameCircularBuffer.hpp	Mon Jul 28 12:48:33 2014 +0000
+++ b/RXTX/XBeeApiRxFrameCircularBuffer.hpp	Mon Jul 28 13:27:58 2014 +0000
@@ -36,12 +36,19 @@
 class XBeeApiRxFrameCircularBuffer : public XBeeApiRxFrameDecoder
 {
     protected:
+        /* TODO: doc */
         size_t          m_bufferSize;
+        /* TODO: doc */
         size_t          m_head;
+        /* TODO: doc */
         size_t          m_tail; 
-    size_t          m_count;
-    XBeeApiRxFrame* m_framesBuffer;
+        /* TODO: doc */
+        size_t          m_count;
+        /* TODO: doc */
+        XBeeApiRxFrame* m_framesBuffer;
+
     public:
+        /* TODO: doc */
         /** Constructor */
         XBeeApiRxFrameCircularBuffer( size_t p_bufferSize, XBeeDevice* p_device = NULL );
         
@@ -49,17 +56,21 @@
         virtual ~XBeeApiRxFrameCircularBuffer( void ); 
 
         /* Callback which is invoked when a frame is successfully decoded
-       \param p_frame The frame content
+           \param p_frame The frame content
         */       
         virtual void frameRxCallback( XBeeApiRxFrame* p_frame );
 
-    size_t getFrameCount() const;
+        /* TODO: doc */
+        size_t getFrameCount() const;
 
-    void clear();
+        /* TODO: doc */
+        void clear();
 
-    void pop();
+        /* TODO: doc */
+        void pop();
 
-    const XBeeApiRxFrame* getTailPtr() const;
+        /* TODO: doc */
+        const XBeeApiRxFrame* getTailPtr() const;
 };
 
 #endif
\ No newline at end of file