Diff: SCP1000.h

Revision:

3:8edd2b18c755

Parent:

2:4c2784b363ad

--- a/SCP1000.h	Fri Feb 04 11:56:49 2011 +0000
+++ b/SCP1000.h	Tue Feb 08 07:26:42 2011 +0000
@@ -4,10 +4,9 @@
 #include "mbed.h"
 
 /**
- * SCP1000 Pressure/Temperature sensor
+ * SCP1000 pressure/temperature sensor
  */
 
-
 class SCP1000 {
 public:
     enum OperationMode {
@@ -20,7 +19,7 @@
     };
     
     /**
-    * Constructor
+    * creates an SCP1000 interface with specified pins
     *
     * @param PinName mosi SPI MOSI pin
     * @param PinName miso SPI MISO pin
@@ -33,51 +32,51 @@
     ~SCP1000() {};
 
     /**
-     * Reads revision number
+     * reads revision number
      *
      * @returns revision number
      */
     int revision();
 
     /**
-     * Checks if data is ready
+     * checks if data is ready
      *
-     * @returns true if data is ready, otherwise false
+     * @returns true if data is ready, false otherwise
      */
     bool isReady();
 
     /**
-     * Perform software reset
+     * performs software reset
      */
     void reset();
 
     /**
-     * Set operation mode
+     * sets operation mode
      */
     void setOperationMode(OperationMode mode);
 
     /**
-     * Perform self test
+     * Performs self test
      *
-     * @returns Result of the test (true if succeeded, otherwise false)
+     * @returns the result of the test (true if succeeded, false otherwise)
      */
     bool performSelfTest();
 
     /**
-     * Read pressure
+     * reads pressure
      *
-     * @param waitForDataReady if true, waits until data becomes ready to read
+     * @param waitForDataReady if true, it will wait until data becomes ready to read
      *
-     * @returns Pressure in hectopascal
+     * @returns pressure in hectopascal
      */
     float readPressure(bool waitForDataReady = false);
 
     /**
-     * Read temperature
+     * reads temperature
      *
-     * @param waitForDataReady if true, waits until data becomes ready to read
+     * @param waitForDataReady if true, it will wait until data becomes ready to read
      *
-     * @returns Temperature in Celsius
+     * @returns temperature in Celsius
      */
     float readTemperature(bool waitForDataReady = false);