aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2011-01-08 11:47:20 +0000
committerDean Camera <dean@fourwalledcubicle.com>2011-01-08 11:47:20 +0000
commit7dc3d3a68f889efeca5af51b22bd043eff8e0926 (patch)
tree059fabcc52c5b6fae0d49e7a59795261fcc7bdcc /LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
parentd1261468875f4772898c4395880735784e651d91 (diff)
downloadlufa-7dc3d3a68f889efeca5af51b22bd043eff8e0926.tar.gz
lufa-7dc3d3a68f889efeca5af51b22bd043eff8e0926.tar.bz2
lufa-7dc3d3a68f889efeca5af51b22bd043eff8e0926.zip
Minor documentation improvements.
Diffstat (limited to 'LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h')
-rw-r--r--LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
index 5a49c47db..2408ad15f 100644
--- a/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
+++ b/LUFA/Drivers/Peripheral/AVRU4U6U7/TWI.h
@@ -145,7 +145,7 @@
*
* \param[in] Byte Byte to send to the currently addressed device
*
- * \return Boolean true if the recipient ACKed the byte, false otherwise
+ * \return Boolean \c true if the recipient ACKed the byte, \c false otherwise
*/
static inline bool TWI_SendByte(const uint8_t Byte)
{
@@ -161,7 +161,7 @@
* \param[in] Byte Location where the read byte is to be stored
* \param[in] LastByte Indicates if the byte should be ACKed if false, NAKed if true
*
- * \return Boolean true if the byte reception successfully completed, false otherwise
+ * \return Boolean \c true if the byte reception successfully completed, \c false otherwise
*/
static inline bool TWI_ReceiveByte(uint8_t* const Byte,
const bool LastByte)
@@ -184,7 +184,7 @@
* \param[in] SlaveAddress Address of the slave TWI device to communicate with
* \param[in] TimeoutMS Timeout period within which the slave must respond, in milliseconds
*
- * \return Boolean true if the device is ready for data, false otherwise
+ * \return Boolean \c true if the device is ready for data, \c false otherwise
*/
bool TWI_StartTransmission(const uint8_t SlaveAddress,
const uint8_t TimeoutMS);