Change the doxygen comments to make them readable by the wizard
[bertos.git] / bertos / cfg / cfg_adc.h
index 26254a41573899b5b6834a8829e81b8566172514..8e3e98a522e8828cd72371eaf838063c85e40db9 100644 (file)
  * the GNU General Public License.
  *
  * Copyright 2008 Develer S.r.l. (http://www.develer.com/)
- * All Rights Reserved.
+ *
  * -->
  *
  * \brief Configuration file for ADC module.
  *
  * \version $Id$
- *
  * \author Daniele Basile <asterix@develer.com>
  */
 
 #ifndef CFG_ADC_H
 #define CFG_ADC_H
 
-/**
- * Logging level definition.
- *
- * Use 0 to log only the error messages
- * Use 1 to log the error and warning messages
- * Use 2 to log all messages
- */
-#define ADC_LOG_LEVEL      2
+/// Module logging level.
+#define ADC_LOG_LEVEL      LOG_LVL_INFO
 
-/**
- * Set logging verbosity.
- *
- * If verbosity is zero print short log messages.
- */
-#define ADC_LOG_VERBOSITY    1
+/// Module logging format.
+#define ADC_LOG_FORMAT     LOG_FMT_VERBOSE
 
 
-/**
- * ADC timing setting parameter
- *
- * - CONFIG_ADC_CLOCK is frequency clock for ADC conversion.
- * - CONFIG_ADC_STARTUP_TIME  minimum time for startup a conversion in micro second.
- * - CONFIG_ADC_SHTIME minimum time for sample and hold in nano second.
- * \{
- */
-#define CONFIG_ADC_CLOCK          4800000UL
-#define CONFIG_ADC_STARTUP_TIME        20
-#define CONFIG_ADC_SHTIME             834
-/* \ * } */
+#define CONFIG_ADC_CLOCK        4800000UL   ///< Frequency clock for ADC conversion.
+#define CONFIG_ADC_STARTUP_TIME 20          ///< Minimum time for startup a conversion in micro second.
+#define CONFIG_ADC_SHTIME       834         ///< Minimum time for sample and hold in nano second
+
+
+#define CONFIG_ADC_AVR_REF      1   ///< ADC setting for AVR target
+#define CONFIG_ADC_AVR_DIVISOR  2   ///< ADC setting for AVR target
 
-/// ADC setting for AVR target
-#define CONFIG_ADC_AVR_REF      1
-#define CONFIG_ADC_AVR_DIVISOR  2
 
 /// Enable ADS strobe.
 #define CONFIG_ADC_STROBE  0
 
 #endif /* CFG_ADC_H */
-