Doc fixes.
[bertos.git] / drv / phase.h
old mode 100755 (executable)
new mode 100644 (file)
index 70e44e5..f4e760e
@@ -1,6 +1,31 @@
-/*!
+/**
  * \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 2005 Develer S.r.l. (http://www.develer.com/)
  * -->
  *
@@ -14,6 +39,9 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.2  2006/07/19 12:56:26  bernie
+ *#* Convert to new Doxygen style.
+ *#*
  *#* Revision 1.1  2005/11/04 18:06:44  bernie
  *#* Import into DevLib.
  *#*
@@ -58,7 +86,7 @@
 #define TRIAC_MAX_POWER 100
 #define TRIAC_POWER_K   TRIAC_MAX_DUTY * (1 / sqrt(2 * TRIAC_MAX_POWER))
 
-/*!
+/**
  * \name Types for duty and power.
  * \{
  */
@@ -69,15 +97,15 @@ typedef uint16_t triac_power_t;
 
 DB(extern bool phase_initialized;)
 
-/*!
+/**
  * \name Type for triac control.
  * \{
  */
 typedef struct Triac
 {
-       Timer  timer;      /*!< Timer for phase control. */
-       triac_duty_t duty; /*!< Duty cycle of the channel. */
-       bool   running;    /*!< True when the timer is active. */
+       Timer  timer;      /**< Timer for phase control. */
+       triac_duty_t duty; /**< Duty cycle of the channel. */
+       bool   running;    /**< True when the timer is active. */
 } Triac;
 /* \} */