AVRISP programmer project now has a more robust timeout system, allowing for a doubli...

[pub/lufa.git] / LUFA / Drivers / Peripheral / AVRU4U6U7 / TWI.h

diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
index 0247668..13db86e 100644 (file)
--- a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
+++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
@@ -39,6 +39,11 @@
 /** \ingroup Group_TWI\r
  *  @defgroup Group_TWI_AVRU4U6U7 Series U4, U6 and U7 Model TWI Driver\r
  *\r
+ *  Master mode TWI driver for the AT90USB1287, AT90USB1286, AT90USB647, AT90USB646, ATMEGA16U4 and ATMEGA32U4 AVRs.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the TWI driver\r
+ *        dispatch header located in LUFA/Drivers/Peripheral/TWI.h.\r
+ *\r
  *  @{\r
  */\r
 \r
@@ -58,7 +63,7 @@
                #endif\r
 \r
        /* Preprocessor Checks: */\r
-               #if !defined(INCLUDE_FROM_TWI_H)\r
+               #if !defined(__INCLUDE_FROM_TWI_H)\r
                        #error Do not include this file directly. Include LUFA/Drivers/Peripheral/TWI.h instead.\r
                #endif\r
 \r
@@ -88,7 +93,7 @@
 \r
                        /** Sends a byte to the currently addressed device on the TWI bus.\r
                         *\r
-                        *  \param Byte  Byte to send to the currently addressed device\r
+                        *  \param[in] Byte  Byte to send to the currently addressed device\r
                         *\r
                         *  \return Boolean true if the recipient ACKed the byte, false otherwise\r
                         */\r
@@ -103,8 +108,8 @@
 \r
                        /** Receives a byte from the currently addressed device on the TWI bus.\r
                         *\r
-                        *  \param Byte  Location where the read byte is to be stored\r
-                        *  \param LastByte  Indicates if the byte should be ACKed if false, NAKed if true\r
+                        *  \param[in] Byte  Location where the read byte is to be stored\r
+                        *  \param[in] LastByte  Indicates if the byte should be ACKed if false, NAKed if true\r
                         *\r
                         *  \return Boolean true if the byte reception sucessfully completed, false otherwise\r
                         */\r
@@ -125,7 +130,7 @@
                /* Function Prototypes: */\r
                        /** Begins a master mode TWI bus communication with the given slave device address.\r
                         *\r
-                        *  \param SlaveAddress  Address of the slave TWI device to communicate with\r
+                        *  \param[in] SlaveAddress  Address of the slave TWI device to communicate with\r
                         *\r
                         *  \return Boolean true if the device is ready for data, false otherwise\r
                         */\r