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

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

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.