Many small fixes and improvements to the documentation

Stéphane Raimbault
1 parent 26131384
Showing 19 changed files with 21 additions and 20 deletions
doc/modbus_close.txt
doc/modbus_connect.txt
doc/modbus_flush.txt
doc/modbus_free.txt
doc/modbus_get_byte_timeout.txt
doc/modbus_get_response_timeout.txt
doc/modbus_new_rtu.txt
doc/modbus_new_tcp.txt
doc/modbus_new_tcp_pi.txt
doc/modbus_receive.txt
doc/modbus_receive_confirmation.txt
doc/modbus_receive_from.txt
doc/modbus_reply_exception.txt
doc/modbus_rtu_get_serial_mode.txt
doc/modbus_rtu_set_serial_mode.txt
doc/modbus_send_raw_request.txt
doc/modbus_set_byte_timeout.txt
doc/modbus_set_debug.txt
doc/modbus_set_response_timeout.txt
@@ -9,7 +9,7 @@ modbus_close - close a Modbus connection
 SYNOPSIS
 --------
-*int modbus_close(*modbus_t 'ctx');*
+*int modbus_close(modbus_t *'ctx');*
 DESCRIPTION
@@ -9,7 +9,7 @@ modbus_connect - establish a Modbus connection
 SYNOPSIS
 --------
-*int modbus_connect(*modbus_t 'ctx');*
+*int modbus_connect(modbus_t *'ctx');*
 DESCRIPTION
@@ -9,7 +9,7 @@ modbus_flush - flush non-transmitted data
 SYNOPSIS
 --------
-*int modbus_flush(*modbus_t 'ctx');*
+*int modbus_flush(modbus_t *'ctx');*
 DESCRIPTION
@@ -9,7 +9,7 @@ modbus_free - free a libmodbus context
 SYNOPSIS
 --------
-*void modbus_free(*modbus_t 'ctx');*
+*void modbus_free(modbus_t *'ctx');*
 DESCRIPTION
@@ -9,7 +9,7 @@ modbus_get_byte_timeout - get timeout between bytes
 SYNOPSIS
 --------
-*void modbus_get_byte_timeout(*modbus_t 'ctx', struct timeval *'timeout');*
+*void modbus_get_byte_timeout(modbus_t *'ctx', struct timeval *'timeout');*
 DESCRIPTION
@@ -9,7 +9,7 @@ modbus_get_response_timeout - get timeout for response
 SYNOPSIS
 --------
-*void modbus_get_response_timeout(*modbus_t 'ctx', struct timeval *'timeout');*
+*void modbus_get_response_timeout(modbus_t *'ctx', struct timeval *'timeout');*
 DESCRIPTION
@@ -9,7 +9,7 @@ modbus_new_rtu - create a libmodbus context for RTU
 SYNOPSIS
 --------
-*modbus_t modbus_new_rtu(const char *'device', int 'baud', char 'parity', int 'data_bit', int 'stop_bit');*
+*modbus_t *modbus_new_rtu(const char *'device', int 'baud', char 'parity', int 'data_bit', int 'stop_bit');*
@@ -9,7 +9,7 @@ modbus_new_tcp - create a libmodbus context for TCP/IPv4
 SYNOPSIS
 --------
-*modbus_t modbus_new_tcp(const char *'ip', int 'port');*
+*modbus_t *modbus_new_tcp(const char *'ip', int 'port');*
 DESCRIPTION
@@ -9,7 +9,7 @@ modbus_new_tcp_pi - create a libmodbus context for TCP Protocol Independent
 SYNOPSIS
 --------
-*modbus_t modbus_new_tcp_pi(const char *'node', const char *'service');*
+*modbus_t *modbus_new_tcp_pi(const char *'node', const char *'service');*
 DESCRIPTION
@@ -9,7 +9,7 @@ modbus_receive - receive a indication request
 SYNOPSIS
 --------
-*int modbus_receive(*modbus_t 'ctx', uint8_t *'req');*
+*int modbus_receive(modbus_t *'ctx', uint8_t *'req');*
 DESCRIPTION
@@ -9,7 +9,7 @@ modbus_receive_confirmation - receive a confirmation request
 SYNOPSIS
 --------
-*int modbus_receive_confirmation(*modbus_t 'ctx', uint8_t *'rsp');*
+*int modbus_receive_confirmation(modbus_t *'ctx', uint8_t *'rsp');*
 DESCRIPTION
@@ -9,7 +9,7 @@ modbus_receive_from - receive a indication request from a socket
 SYNOPSIS
 --------
-*int modbus_receive_from(*modbus_t 'ctx', int sockfd, uint8_t *'req');*
+*int modbus_receive_from(modbus_t *'ctx', int sockfd, uint8_t *'req');*
 DESCRIPTION
@@ -41,7 +41,7 @@ successful. Otherwise it shall return -1 and set errno.
 ERRORS
 ------
-EINVAL::
+*EINVAL*::
 The exception code is invalid
@@ -9,7 +9,7 @@ modbus_rtu_get_serial_mode - get the current serial mode
 SYNOPSIS
 --------
-*int modbus_rtu_get_serial_mode(*modbus_t 'ctx');*
+*int modbus_rtu_get_serial_mode(modbus_t *'ctx');*
 DESCRIPTION
@@ -30,7 +30,8 @@ currently used by the libmodbus context:
  automation because it can be used effectively over long distances and in
  electrically noisy environments.
-This function is only available on Linux kernels 2.6.28 onwards.
+This function is only available on Linux kernels 2.6.28 onwards and can only be
+used with a context using a RTU backend.
 RETURN VALUE
@@ -9,7 +9,7 @@ modbus_rtu_set_serial_mode - set the serial mode
 SYNOPSIS
 --------
-*int modbus_rtu_set_serial_mode(*modbus_t 'ctx');*
+*int modbus_rtu_set_serial_mode(modbus_t *'ctx');*
 DESCRIPTION
@@ -9,7 +9,7 @@ modbus_send_raw_request - send a raw request
 SYNOPSIS
 --------
-*int modbus_send_raw_request(*modbus_t 'ctx', uint8_t *'raw_req, int 'raw_req_length');*
+*int modbus_send_raw_request(modbus_t *'ctx', uint8_t *'raw_req, int 'raw_req_length');*
 DESCRIPTION
@@ -9,7 +9,7 @@ modbus_set_byte_timeout - set timeout between bytes
 SYNOPSIS
 --------
-*void modbus_set_byte_timeout(*modbus_t 'ctx', struct timeval *'timeout');*
+*void modbus_set_byte_timeout(modbus_t *'ctx', struct timeval *'timeout');*
 DESCRIPTION
@@ -8,7 +8,7 @@ modbus_set_debug - set debug flag of the context
 SYNOPSIS
 --------
-*void modbus_set_debug(*modbus_t 'ctx', int 'boolean');*
+*void modbus_set_debug(modbus_t *'ctx', int 'boolean');*
 DESCRIPTION
@@ -9,7 +9,7 @@ modbus_set_response_timeout - set timeout for response
 SYNOPSIS
 --------
-*void modbus_set_response_timeout(*modbus_t 'ctx', struct timeval *'timeout');*
+*void modbus_set_response_timeout(modbus_t *'ctx', struct timeval *'timeout');*
 DESCRIPTION