doc: Remove doxygen warnings.

[bertos.git] / bertos / cfg / cfg_ramp.h

diff --git a/bertos/cfg/cfg_ramp.h b/bertos/cfg/cfg_ramp.h
index e452766086559211465759c0699d2b2038a674a2..162d2db28293e93084d1d1114abf42c782b5085b 100644 (file)
--- a/bertos/cfg/cfg_ramp.h
+++ b/bertos/cfg/cfg_ramp.h
@@ -1,4 +1,4 @@
-/**
+ /**
  * \file
  * <!--
  * This file is part of BeRTOS.
@@ -32,7 +32,6 @@
  *
  * \brief Configuration file Ramp algorithm module.
  *
- * \version $Id$
  * \author Daniele Basile <asterix@develer.com>
  */
 
@@ -47,7 +46,7 @@
  * \note Floating point operations will be always done within ramp_compute() to
  * precalculate values, so there has to be at least a floating point emulation support.
  *
- * $WIZARD = { "type" : "boolean" }
+ * $WIZ$ type = "boolean"
  */
 #define RAMP_USE_FLOATING_POINT   0
 
@@ -67,22 +66,50 @@
         * a runtime assertion.
         *
         * \note This macro is used only for the fixed-point version of the ramp.
-        * $WIZARD = { "type" : "int", "min" : "0", "max" : "32" }
+        * $WIZ$ type = "int"
+        * $WIZ$ min = 0
+        * $WIZ$ max = 32
         */
        #define RAMP_CLOCK_SHIFT_PRECISION 2
 #endif
 
 
-///< Negative pulse width for ramp. $WIZARD = { "type" : "int", "min" : "0" }
+/**
+* Negative pulse width for ramp.
+* $WIZ$ type = "int"
+* $WIZ$ min = 1
+*/
 #define RAMP_PULSE_WIDTH    50
 
- /*
-  * Default ramp
-  */
-#define RAMP_DEF_TIME     6000000UL ///< microsecs.                $WIZARD = { "type" : "int",  "long" : True, "unsigned" : True }
-#define RAMP_DEF_MAXFREQ       5000 ///< Hz.                       $WIZARD = { "type" : "int", "min" : "0" }
-#define RAMP_DEF_MINFREQ        200 ///< Hz.                       $WIZARD = { "type" : "int", "min" : "0" }
-#define RAMP_DEF_POWERRUN        10 ///< 10 deciampere (1 ampere). $WIZARD = { "type" : "int", "min" : "0" }
-#define RAMP_DEF_POWERIDLE        1 ///< 1 deciampere.             $WIZARD = { "type" : "int", "min" : "0" }
+/**
+ * Default ramp time (microsecs).
+ * $WIZ$ type = "int"
+ * $WIZ$ min = 1000
+ */
+#define RAMP_DEF_TIME     6000000UL
+/**
+ * Default ramp maxfreq (Hz).
+ * $WIZ$ type = "int"
+ * $WIZ$ min = 1
+ */
+#define RAMP_DEF_MAXFREQ       5000
+/**
+ * Default ramp minfreq (Hz).
+ * $WIZ$ type = "int"
+ * $WIZ$ min = 1
+ */
+#define RAMP_DEF_MINFREQ        200
+/**
+ * Default ramp powerrun (deciampere).
+ * $WIZ$ type = "int"
+ * $WIZ$ min = 0
+ */
+#define RAMP_DEF_POWERRUN        10
+/**
+ * Default ramp poweridle (Hz).
+ * $WIZ$ type = "int"
+ * $WIZ$ min = 0
+ */
+#define RAMP_DEF_POWERIDLE        1
 
 #endif /* CFG_RAMP_H */