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: mbed 4DGL-uLCD-SE mbed-rtos nRF24L01P
Diff: CircularBuf.h
- Revision:
- 36:c3cac3494e9b
- Parent:
- 35:99aa54a25a9e
- Child:
- 37:b146a0a0b894
diff -r 99aa54a25a9e -r c3cac3494e9b CircularBuf.h
--- a/CircularBuf.h Sun Apr 29 15:17:38 2018 +0000
+++ b/CircularBuf.h Sun Apr 29 15:23:56 2018 +0000
@@ -17,7 +17,7 @@
//
/**
* @param size Size of the buffer.
- *Assigns a circular buffer of the diven size.
+ * Assigns a circular buffer of the diven size.
*/
CircularBuf(unsigned int size);
~CircularBuf();
@@ -27,19 +27,19 @@
// Arguement:
* @param data The array of data to add to the buffer.
* @param size The size of the array "data"
- // data, The array of data to add
- // size, The amount of data in the array
- // Return:
- // Amount of data actually written
- //
- // Example Code:
- //
- // int dataToAdd[2];
- // dataToAdd[0] = 15;
- // dataToAdd[1] = 23;
- // buffer.push(dataToAdd, 2);
- //
- // buffer now contains [15, 23]
+ * data, The array of data to add
+ * size, The amount of data in the array
+ * Return:
+ * Amount of data actually written
+ *
+ * Example Code:
+ *
+ * int dataToAdd[2];
+ * dataToAdd[0] = 15;
+ * dataToAdd[1] = 23;
+ * buffer.push(dataToAdd, 2);
+ *
+ * buffer now contains [15, 23]
*/
unsigned int push(T* data, unsigned int size);