Add verbose/quiet modes for docs, check and tags rules.
[bertos.git] / drv / thermo.h
old mode 100755 (executable)
new mode 100644 (file)
index 361f966..693c086
@@ -1,8 +1,33 @@
-/*!
+/**
  * \file
  * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * Copyright 2004, 2005 Develer S.r.l. (http://www.develer.com/)
- * This file is part of DevLib - See README.devlib for information.
+ *
  * -->
  *
  * \brief Thermo-control driver
 
 /*#*
  *#* $Log$
+ *#* Revision 1.3  2006/09/20 20:12:41  marco
+ *#* Names convention, MOD_* macros.
+ *#*
+ *#* Revision 1.2  2006/07/19 12:56:26  bernie
+ *#* Convert to new Doxygen style.
+ *#*
  *#* Revision 1.1  2005/11/04 17:59:47  bernie
  *#* Import into DevLib.
  *#*
@@ -58,7 +89,7 @@
 void thermo_init(void);
 
 
-/*!
+/**
  * Set the target temperature at which a given device should be kept.
  *
  * \param dev Device
@@ -66,26 +97,26 @@ void thermo_init(void);
  */
 void thermo_setTarget(ThermoDev dev, deg_t temperature);
 
-/*! Start thermo control for a certain device \a dev */
+/** Start thermo control for a certain device \a dev */
 void thermo_start(ThermoDev dev);
 
-/*! Stop thermo control for a certain device \a dev */
+/** Stop thermo control for a certain device \a dev */
 void thermo_stop(ThermoDev dev);
 
-/*! Clear errors for channel \a dev */
+/** Clear errors for channel \a dev */
 void thermo_clearErrors(ThermoDev dev);
 
-/*! Return the status of the specific \a dev thermo-device. */
+/** Return the status of the specific \a dev thermo-device. */
 thermostatus_t thermo_status(ThermoDev dev);
 
-/*!
+/**
  * Return the current temperature of a device currently under thermo
  * control.
  *
  * \param dev Device
  * \return Current temperature (Celsius degrees * 10)
  */
-deg_t thermo_read_temperature(ThermoDev dev);
+deg_t thermo_readTemperature(ThermoDev dev);
 
 
 #endif /* DRV_THERMO_H */