diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2012-02-24 20:25:36 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2012-02-24 20:25:36 +0000 |
| commit | e406140f119281a945c281d25e9a1041b862d592 (patch) | |
| tree | d8ad16a77830f8116e5ae5bdbe99fcb263a7f9d6 /LUFA/Drivers/Peripheral/AVR8 | |
| parent | 5561524a8fe7baaeaac3421c9e1d3347186fdf95 (diff) | |
| download | lufa-e406140f119281a945c281d25e9a1041b862d592.tar.gz lufa-e406140f119281a945c281d25e9a1041b862d592.tar.bz2 lufa-e406140f119281a945c281d25e9a1041b862d592.zip | |
Minor documentation fixes - change \note entries to \warning where appropriate and remove/update old documentation.
Diffstat (limited to 'LUFA/Drivers/Peripheral/AVR8')
| -rw-r--r-- | LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h | 10 | ||||
| -rw-r--r-- | LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h | 4 |
2 files changed, 6 insertions, 8 deletions
diff --git a/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h index b4b2b1f97..ec80dd247 100644 --- a/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h +++ b/LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h @@ -253,8 +253,8 @@ /** 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. */ @@ -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. - * \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. */ @@ -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. - * \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. */ diff --git a/LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h index 17c1e5c27..b9131df3c 100644 --- a/LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h +++ b/LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h @@ -196,8 +196,8 @@ * * The generated SCL frequency will be according to the formula <pre>F_CPU / (16 + 2 * BitLength + 4 ^ Prescale)</pre>. * - * \note The value of the \c BitLength parameter should not be set below 10 or invalid bus conditions may - * occur, as indicated in the AVR8 microcontroller datasheet. + * \attention The value of the \c BitLength parameter should not be set below 10 or invalid bus conditions may + * occur, as indicated in the AVR8 microcontroller datasheet. * * \param[in] Prescale Prescaler to use when determining the bus frequency, a \c TWI_BIT_PRESCALE_* value. * \param[in] BitLength Length of the bits sent on the bus. |