Diff: SRF02.h

Revision:

1:6b978ea41787

Parent:

0:8ac34d529a3b

Child:

2:9da88e2889b6

diff -r 8ac34d529a3b -r 6b978ea41787 SRF02.h
--- 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