From 08feb80580ca82cfebd77a43d14d1197ec7c4f99 Mon Sep 17 00:00:00 2001
From: gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>
Date: Thu, 29 Dec 2011 22:18:25 +0000
Subject: [PATCH] git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3686
 35acf78f-673a-0410-8e92-d51de3d6d3f4

---
 os/hal/src/i2c.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/os/hal/src/i2c.c b/os/hal/src/i2c.c
index 5cf5cb4f7..598719d24 100644
--- a/os/hal/src/i2c.c
+++ b/os/hal/src/i2c.c
@@ -169,7 +169,8 @@ i2cflags_t i2cGetErrors(I2CDriver *i2cp) {
  *                      - @a TIME_INFINITE no timeout.
  *                      .
  *
- * @return              The number of received bytes or an exit code.
+ * @return              The operation status.
+ * @retval RDY_OK       if the function succeeded.
  * @retval RDY_RESET    if one or more I2C errors occurred, the errors can
  *                      be retrieved using @p i2cGetErrors().
  * @retval RDY_TIMEOUT  if a timeout occurred before operation end.
@@ -218,7 +219,7 @@ msg_t i2cMasterTransmitTimeout(I2CDriver *i2cp,
  *                      - @a TIME_INFINITE no timeout.
  *                      .
  *
- * @return              The number of received bytes or an exit code.
+ * @return              The operation status.
  * @retval RDY_OK       if the function succeeded.
  * @retval RDY_RESET    if one or more I2C errors occurred, the errors can
  *                      be retrieved using @p i2cGetErrors().