Browse Source

Add a comment for modbus_connect.

Stéphane Raimbault 17 years ago
parent
commit
4bc609841e
2 changed files with 4 additions and 2 deletions
  1. 2 1
      modbus/modbus.c
  2. 2 1
      modbus/modbus.h

+ 2 - 1
modbus/modbus.c

@@ -1659,7 +1659,8 @@ static int modbus_connect_tcp(modbus_param_t *mb_param)
         return 0;
 }
 
-/* Establishes a modbus connexion */
+/* Establishes a modbus connexion.
+   Returns -1 if an error occured. */
 int modbus_connect(modbus_param_t *mb_param)
 {
         int ret;

+ 2 - 1
modbus/modbus.h

@@ -241,7 +241,8 @@ void modbus_init_tcp(modbus_param_t *mb_param, char *ip_address, int port);
  */
 void modbus_set_error_handling(modbus_param_t *mb_param, error_handling_t error_handling);
 
-/* Establishes a modbus connexion */
+/* Establishes a modbus connexion.
+   Returns -1 if an error occured. */
 int modbus_connect(modbus_param_t *mb_param);
 
 /* Closes a modbus connection */