Jan Kamidra / WeatherMeters

Fork of https://os.mbed.com/users/okini3939/code/WeatherMeters/

Diff: WeatherMeters.h

Revision:
1:fa262295fa7e
Parent:
0:dc42aeff64e6
Child:
2:6a62f29b1bb5
--- a/WeatherMeters.h	Thu Oct 14 11:58:22 2010 +0000
+++ b/WeatherMeters.h	Thu Jan 06 13:23:24 2011 +0000
@@ -4,16 +4,28 @@
  * Released under the MIT License: http://mbed.org/license/mit
  */
  
+/** @file WeatherMeters.h
+ * @brief mbed library to use a Sparkfun Weather Meters
+ * Anemometer, Wind vane, Rain gauge
+ * interface: digital, analog
+ */
+ 
 #ifndef WeatherMeters_H
 #define WeatherMeters_H
 
 #include "mbed.h"
 
+/**
+ * @brief parameter of Anemometer
+ */
 enum Weather_mode {
     Weather_manual = 0,
     Weather_auto = 1
 };
 
+/**
+ * @brief WeatherMeters class
+ */
 class WeatherMeters : public Base {
 public:
     WeatherMeters(PinName p_anemometer, PinName p_windvane, PinName p_raingauge, Weather_mode w_mode = Weather_auto);