Fix corrupt Doxygen configuration files, update project names.

[pub/USBasp.git] / LUFA / Drivers / Peripheral / AVR8 / ADC_AVR8.h

diff --git a/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
index a0e9a87..ec80dd2 100644 (file)
--- a/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
+++ b/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2012.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -104,7 +104,7 @@
                        #define _ADC_GET_MUX_MASK2(y)           ADC_CHANNEL ## y
                        #define _ADC_GET_MUX_MASK(y)            _ADC_GET_MUX_MASK2(y)
        #endif
                        #define _ADC_GET_MUX_MASK2(y)           ADC_CHANNEL ## y
                        #define _ADC_GET_MUX_MASK(y)            _ADC_GET_MUX_MASK2(y)
        #endif

-       
+

        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        /** \name ADC Reference Configuration Masks */
        /* Public Interface - May be used in end-application: */
                /* Macros: */
                        /** \name ADC Reference Configuration Masks */


@@ -118,7 +118,7 @@
                        /** Reference mask, for using the internally generated 2.56V reference voltage as the ADC reference. */
                        #define ADC_REFERENCE_INT2560MV         ((1 << REFS1) | (1 << REFS0))
                        //@}
                        /** Reference mask, for using the internally generated 2.56V reference voltage as the ADC reference. */
                        #define ADC_REFERENCE_INT2560MV         ((1 << REFS1) | (1 << REFS0))
                        //@}

-                       
+

                        /** \name ADC Result Adjustment Configuration Masks */
                        //@{
                        /** Left-adjusts the 10-bit ADC result, so that the upper 8 bits of the value returned by the
                        /** \name ADC Result Adjustment Configuration Masks */
                        //@{
                        /** Left-adjusts the 10-bit ADC result, so that the upper 8 bits of the value returned by the


@@ -144,7 +144,7 @@
                         */
                        #define ADC_SINGLE_CONVERSION           (0 << ADATE)
                        //@}
                         */
                        #define ADC_SINGLE_CONVERSION           (0 << ADATE)
                        //@}

-                       
+

                        /** \name ADC Prescaler Configuration Masks */
                        //@{
                        /** Sets the ADC input clock to prescale by a factor of 2 the AVR's system clock. */
                        /** \name ADC Prescaler Configuration Masks */
                        //@{
                        /** Sets the ADC input clock to prescale by a factor of 2 the AVR's system clock. */


@@ -253,8 +253,8 @@
 
                        /** Retrieves the ADC MUX mask for the given ADC channel number.
                         *
 
                        /** Retrieves the ADC MUX mask for the given ADC channel number.
                         *

-                        *  \note This macro will only work correctly on channel numbers that are compile-time
-                        *        constants defined by the preprocessor.
+                        *  \attention This macro will only work correctly on channel numbers that are compile-time
+                        *             constants defined by the preprocessor.

                         *
                         *  \param[in] Channel  Index of the ADC channel whose MUX mask is to be retrieved.
                         */
                         *
                         *  \param[in] Channel  Index of the ADC channel whose MUX mask is to be retrieved.
                         */


@@ -268,9 +268,8 @@
                         *
                         *  \note This must only be called for ADC channels with are connected to a physical port
                         *        pin of the AVR, denoted by its special alternative function ADCx.
                         *
                         *  \note This must only be called for ADC channels with are connected to a physical port
                         *        pin of the AVR, denoted by its special alternative function ADCx.

-                        *        \n\n

                         *
                         *

-                        *  \note The channel number must be specified as an integer, and <b>not</b> a \c ADC_CHANNEL* mask.
+                        *  \warning The channel number must be specified as an integer, and <b>not</b> a \c ADC_CHANNEL* mask.

                         *
                         *  \param[in] ChannelIndex  ADC channel number to set up for conversions.
                         */
                         *
                         *  \param[in] ChannelIndex  ADC channel number to set up for conversions.
                         */


@@ -311,9 +310,8 @@
                         *
                         *  \note This must only be called for ADC channels with are connected to a physical port
                         *        pin of the AVR, denoted by its special alternative function ADCx.
                         *
                         *  \note This must only be called for ADC channels with are connected to a physical port
                         *        pin of the AVR, denoted by its special alternative function ADCx.

-                        *        \n\n

                         *
                         *

-                        *  \note The channel number must be specified as an integer, and <b>not</b> a \c ADC_CHANNEL* mask.
+                        *  \warning The channel number must be specified as an integer, and <b>not</b> a \c ADC_CHANNEL* mask.

                         *
                         *  \param[in] ChannelIndex  ADC channel number to set up for conversions.
                         */
                         *
                         *  \param[in] ChannelIndex  ADC channel number to set up for conversions.
                         */