From e0ea0303cd0145ab66a3a7baed4430dadbb7400b Mon Sep 17 00:00:00 2001
From: Stéphane Raimbault <stephane.raimbault@gmail.com>
Date: Sun, 18 May 2008 01:32:04 +0200
Subject: [PATCH] Comment about receive_msg().

---
 modbus/modbus.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/modbus/modbus.c b/modbus/modbus.c
index e768819..30e1e2c 100644
--- a/modbus/modbus.c
+++ b/modbus/modbus.c
@@ -461,9 +461,9 @@ static int compute_query_length_data(modbus_param_t *mb_param, uint8_t *msg)
 
    msg_length_computed must be set to MSG_LENGTH_COMPUTED if undefined
 
-   Returns:
-   - 0: OK, <0: error
-   - msg_length: number of characters received. */
+   Returns a negative number if an error occured.
+   The variable msg_length is assigned to the number of characters
+   received. */
 int receive_msg(modbus_param_t *mb_param,
                 int msg_length_computed,
                 uint8_t *msg, int *msg_length)
--
libgit2 0.21.4