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.
Revision 1:6b978ea41787, committed 2011-12-16
- Comitter:
- bobboteck
- Date:
- Fri Dec 16 14:09:37 2011 +0000
- Parent:
- 0:8ac34d529a3b
- Commit message:
- Modified Oxygen tag
Changed in this revision
| SRF02.h | Show annotated file Show diff for this revision Revisions of this file |
--- a/SRF02.h Fri Dec 16 14:00:06 2011 +0000
+++ b/SRF02.h Fri Dec 16 14:09:37 2011 +0000
@@ -31,7 +31,7 @@
#define INCHES_RESULT 0x50 // For result in inches
#define CENTIMETERS_RESULT 0x51 // For result in centimeters
#define MICROSECONDS_RESULT 0x52 // For result in micro-seconds
-/* Library for the SRF02 Ultrasonic Ranger Sensor, using the I2C bus for the
+/** Library for the SRF02 Ultrasonic Ranger Sensor, using the I2C bus for the
* comunication. Remeber that sensor can function in serial mode if MODE pin
* is connected to the ground, but this libary not support this mode.
*
@@ -60,7 +60,7 @@
{
public:
enum measure_type{INCHES=0x050,CENTIMETERS=0x51,MICROSECONDS=0x52};
- /* Creates an instance of class. Setting the pin used for I2C, the address of device and the measure range type.
+ /** Creates an instance of class. Setting the pin used for I2C, the address of device and the measure range type.
*
* @param sda A pin used for SDA I2C signal.
* @param scl A pin used for SCL I2C signal.
@@ -72,7 +72,7 @@
/* Destroyer of class instance. */
~SRF02();
- /* Start and return the range measure.
+ /** Start and return the range measure.
*
* @returns The value of measure.
*/
@@ -81,7 +81,7 @@
private:
I2C _i2c; // I2C object to comunicate with SRF02
int _addr; // Address of sensor
- char _typem; // Type of mesure
+ char _typem; // Type of mesure
};
#endif