Diff: SCP1000.h

Revision:

7:61d2e698d988

Parent:

4:295e118b6e85

Child:

8:1049590388b6

--- a/SCP1000.h	Tue Oct 05 20:04:30 2010 +0000
+++ b/SCP1000.h	Fri Oct 08 17:39:06 2010 +0000
@@ -9,17 +9,30 @@
 
 class SCP1000 {
     public:
+        /**
+         * Constructor.
+         *
+         * @param mosi SPI MOSI pin
+         * @param miso SPI MISO pin
+         * @param sclk SPI SCLK pin
+         * @param cs Chip select pin
+         */
         SCP1000(PinName mosi, PinName miso, PinName sclk, PinName cs);
         
         ~SCP1000() { /* empty */ };
         
-        ///Reads the pressure
         /**
-            Reads the pressure from the sensor
-            @return Pressure in pascals.
-        */
+         * Read the pressure.
+         *
+         * @returns The pressure in pascals.
+         */
         unsigned long readPressure();
         
+        /**
+         * Read the temperature.
+         *
+         * @returns The temperature in Celsius.
+         */
         float readTemperature();