ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor documentation fixes - change \note entries to \warning where appropriate and remove/update old documentation.

Browse source
This commit is contained in:
Dean Camera 2012-02-24 20:25:36 +00:00
parent 5561524a8f
commit e406140f11
32 changed files with 134 additions and 158 deletions
Download patch file Download diff file Expand all files Collapse all files

10
LUFA/Drivers/Peripheral/AVR8/ADC_AVR8.h
View file

@ -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.
*/

4
LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h
View file

@ -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.