Commit 201a2f294e1dfdb488eb139665abd41adedf5400
1 parent
9c3f5c71
Small documentation fixes by shagol (closes #20).
Showing
3 changed files
with
4 additions
and
5 deletions
doc/modbus_close.txt
| @@ -9,7 +9,7 @@ modbus_close - close a Modbus connection | @@ -9,7 +9,7 @@ modbus_close - close a Modbus connection | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*int modbus_close(modbus_t *'ctx');* | 12 | +*void modbus_close(modbus_t *'ctx');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
| @@ -20,8 +20,7 @@ backend set in the context. | @@ -20,8 +20,7 @@ backend set in the context. | ||
| 20 | 20 | ||
| 21 | RETURN VALUE | 21 | RETURN VALUE |
| 22 | ------------ | 22 | ------------ |
| 23 | -The _modbus_close()_ function shall return 0 if successful. Otherwise it shall | ||
| 24 | -return -1 and set errno. | 23 | +There is no return value. |
| 25 | 24 | ||
| 26 | 25 | ||
| 27 | EXAMPLE | 26 | EXAMPLE |
doc/modbus_get_header_length.txt
| @@ -15,7 +15,7 @@ SYNOPSIS | @@ -15,7 +15,7 @@ SYNOPSIS | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
| 16 | ----------- | 16 | ----------- |
| 17 | The _modbus_get_header_length()_ function shall retrieve the current header | 17 | The _modbus_get_header_length()_ function shall retrieve the current header |
| 18 | -length from the backend. This fonction is convenient to manipulate a message and | 18 | +length from the backend. This function is convenient to manipulate a message and |
| 19 | so its limited to low-level operations. | 19 | so its limited to low-level operations. |
| 20 | 20 | ||
| 21 | 21 |
doc/modbus_read_input_bits.txt
| @@ -21,7 +21,7 @@ in 'dest' array as unsigned bytes (8 bits) set to _TRUE_ or _FALSE_. | @@ -21,7 +21,7 @@ in 'dest' array as unsigned bytes (8 bits) set to _TRUE_ or _FALSE_. | ||
| 21 | You must take care to allocate enough memory to store the results in 'dest' | 21 | You must take care to allocate enough memory to store the results in 'dest' |
| 22 | (at least 'nb' * sizeof(uint8_t)). | 22 | (at least 'nb' * sizeof(uint8_t)). |
| 23 | 23 | ||
| 24 | -The function uses the Modbus function code 0x03 (read input status). | 24 | +The function uses the Modbus function code 0x02 (read input status). |
| 25 | 25 | ||
| 26 | 26 | ||
| 27 | RETURN VALUE | 27 | RETURN VALUE |