Diff: BMP085.h

Revision:

1:80e4c62baf09

Parent:

0:6245372b9179

Child:

2:5e2b1f3c0a6a

--- a/BMP085.h	Thu Oct 14 11:28:45 2010 +0000
+++ b/BMP085.h	Mon Dec 13 14:02:24 2010 +0000
@@ -4,18 +4,30 @@
  * Released under the MIT License: http://mbed.org/license/mit
  */
  
+/** @file BMP085.h
+ * @brief mbed library to use a Bosch Sensortec BMP085 sensor
+ * barometric pressure sensor BMP085 (Bosch Sensortec)
+ * interface: I2C digital
+ */
+ 
 #ifndef BMP085_H
 #define BMP085_H
 
 #include "mbed.h"
 
+/**
+ * @brief over sampling setting
+ */
 enum BMP085_oss {
-    BMP085_oss1 = 0,
-    BMP085_oss2 = 1,
-    BMP085_oss4 = 2,
-    BMP085_oss8 = 3
+    BMP085_oss1 = 0, ///< ultra low power (1 time)
+    BMP085_oss2 = 1, ///< standard (2 times)
+    BMP085_oss4 = 2, ///< high resolution (4 times)
+    BMP085_oss8 = 3  ///< ultra high resolution (8 times)
 };
 
+/**
+ * @brief BMP085 class
+ */
 class BMP085 : public Base {
 public:
     BMP085(PinName p_sda, PinName p_scl, BMP085_oss p_oss = BMP085_oss1);