Minor documentation improvements.

[pub/lufa.git] / LUFA / Drivers / Peripheral / AVR8 / TWI_AVR8.h

diff --git a/LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h b/LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h
index 5a6c296..80de7da 100644 (file)
--- a/LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h
+++ b/LUFA/Drivers/Peripheral/AVR8/TWI_AVR8.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2013.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2013  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
@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
@@ -88,7 +88,7 @@
  *          }
  *      }
  *  \endcode
- * 
+ *
  *  <b>High Level API Example:</b>
  *  \code
  *      // Initialize the TWI driver before first use at 200KHz
@@ -133,8 +133,7 @@
 
                #if !(defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB646__) || \
                      defined(__AVR_AT90USB1287__) || defined(__AVR_AT90USB647__) || \
-                         defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__) || \
-                         defined(__AVR_ATmega32U6__))
+                         defined(__AVR_ATmega16U4__)  || defined(__AVR_ATmega32U4__))
                        #error The TWI peripheral driver is not currently available for your selected microcontroller model.
                #endif
 
@@ -154,10 +153,10 @@
                         *  or \ref TWI_ADDRESS_WRITE to obtain the device's read and write address respectively.
                         */
                        #define TWI_DEVICE_ADDRESS_MASK  0xFE
-                       
+
                        /** Bit length prescaler for \ref TWI_Init(). This mask multiplies the TWI bit length prescaler by 1. */
                        #define TWI_BIT_PRESCALE_1       ((0 << TWPS1) | (0 << TWPS0))
-                       
+
                        /** Bit length prescaler for \ref TWI_Init(). This mask multiplies the TWI bit length prescaler by 4. */
                        #define TWI_BIT_PRESCALE_4       ((0 << TWPS1) | (1 << TWPS0))
 
@@ -166,7 +165,7 @@
 
                        /** Bit length prescaler for \ref TWI_Init(). This mask multiplies the TWI bit length prescaler by 64. */
                        #define TWI_BIT_PRESCALE_64      ((1 << TWPS1) | (1 << TWPS0))
-                       
+
                        /** Calculates the length of each bit on the TWI bus for a given target frequency. This may be used with
                         *  the \ref TWI_Init() function to convert a bus frequency to a number of clocks for the \c BitLength
                         *  parameter.
@@ -189,21 +188,23 @@
                                TWI_ERROR_SlaveNotReady        = 4, /**< Slave NAKed the TWI bus START condition. */
                                TWI_ERROR_SlaveNAK             = 5, /**< Slave NAKed whilst attempting to send data to the device. */
                        };
-       
+
                /* Inline Functions: */
                        /** Initializes the TWI hardware into master mode, ready for data transmission and reception. This must be
                         *  before any other TWI operations.
                         *
                         *  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.
                         */
-                       static inline void TWI_Init(const uint8_t Prescale, const uint8_t BitLength) ATTR_ALWAYS_INLINE;
-                       static inline void TWI_Init(const uint8_t Prescale, const uint8_t BitLength)
+                       static inline void TWI_Init(const uint8_t Prescale,
+                                                   const uint8_t BitLength) ATTR_ALWAYS_INLINE;
+                       static inline void TWI_Init(const uint8_t Prescale,
+                                                   const uint8_t BitLength)
                        {
                                TWCR |= (1 << TWEN);
                                TWSR  = Prescale;
@@ -254,9 +255,7 @@
                         */
                        bool TWI_ReceiveByte(uint8_t* const Byte,
                                             const bool LastByte) ATTR_NON_NULL_PTR_ARG(1);
-                       bool TWI_ReceiveByte(uint8_t* const Byte,
-                                            const bool LastByte);
-                                        
+
                        /** High level function to perform a complete packet transfer over the TWI bus to the specified
                         *  device.
                         *