Commit c2313dd979f935695d91a5dcd11794004f3044a4
1 parent
51495a9a
Add traling ';' to all synopsises in the documentation
Showing
17 changed files
with
17 additions
and
19 deletions
doc/modbus_get_header_length.txt
| @@ -9,7 +9,7 @@ modbus_get_header_length - retrieve the current header length | @@ -9,7 +9,7 @@ modbus_get_header_length - retrieve the current header length | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*int modbus_get_header_length(*modbus_t 'ctx');* | 12 | +*int modbus_get_header_length(modbus_t *'ctx');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
doc/modbus_get_socket.txt
| @@ -9,7 +9,7 @@ modbus_get_socket - get the current socket of the context | @@ -9,7 +9,7 @@ modbus_get_socket - get the current socket of the context | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*int modbus_get_socket(modbus_t *'ctx')* | 12 | +*int modbus_get_socket(modbus_t *'ctx');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
doc/modbus_mapping_free.txt
| @@ -9,7 +9,7 @@ modbus_mapping_free - free a modbus_mapping_t structure | @@ -9,7 +9,7 @@ modbus_mapping_free - free a modbus_mapping_t structure | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*void modbus_mapping_free(modbus_mapping_t *'mb_mapping')* | 12 | +*void modbus_mapping_free(modbus_mapping_t *'mb_mapping');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
doc/modbus_mapping_new.txt
| @@ -9,7 +9,7 @@ modbus_mapping_new - allocate four arrays of bits and registers | @@ -9,7 +9,7 @@ modbus_mapping_new - allocate four arrays of bits and registers | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*modbus_mapping_t* modbus_mapping_new(int 'nb_bits', int 'nb_input_bits', int 'nb_registers', int 'nb_input_registers')* | 12 | +*modbus_mapping_t* modbus_mapping_new(int 'nb_bits', int 'nb_input_bits', int 'nb_registers', int 'nb_input_registers');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
doc/modbus_new_rtu.txt
| @@ -9,8 +9,7 @@ modbus_new_rtu - create a libmodbus context for RTU | @@ -9,8 +9,7 @@ modbus_new_rtu - create a libmodbus context for RTU | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*modbus_t modbus_new_rtu(const char *'device', int 'baud', | ||
| 13 | - char 'parity', int 'data_bit', int 'stop_bit')* | 12 | +*modbus_t modbus_new_rtu(const char *'device', int 'baud', char 'parity', int 'data_bit', int 'stop_bit');* |
| 14 | 13 | ||
| 15 | 14 | ||
| 16 | 15 |
doc/modbus_read_bits.txt
| @@ -9,7 +9,7 @@ modbus_read_bits - read many bits | @@ -9,7 +9,7 @@ modbus_read_bits - read many bits | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*int modbus_read_bits(modbus_t *'ctx', int 'addr', int 'nb', uint8_t *'dest')* | 12 | +*int modbus_read_bits(modbus_t *'ctx', int 'addr', int 'nb', uint8_t *'dest');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
doc/modbus_read_input_registers.txt
| @@ -9,7 +9,7 @@ modbus_read_input_registers - read many input registers | @@ -9,7 +9,7 @@ modbus_read_input_registers - read many input registers | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*int modbus_read_input_registers(modbus_t *'ctx', int 'addr', int 'nb', uint16_t *'dest')* | 12 | +*int modbus_read_input_registers(modbus_t *'ctx', int 'addr', int 'nb', uint16_t *'dest');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
doc/modbus_read_registers.txt
| @@ -9,7 +9,7 @@ modbus_read_registers - read many registers | @@ -9,7 +9,7 @@ modbus_read_registers - read many registers | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*int modbus_read_registers(modbus_t *'ctx', int 'addr', int 'nb', uint16_t *'dest')* | 12 | +*int modbus_read_registers(modbus_t *'ctx', int 'addr', int 'nb', uint16_t *'dest');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
doc/modbus_report_slave_id.txt
| @@ -9,7 +9,7 @@ modbus_report_slave_id - returns a description of the controller | @@ -9,7 +9,7 @@ modbus_report_slave_id - returns a description of the controller | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*int modbus_report_slave_id(modbus_t *'ctx', uint8_t *'dest')* | 12 | +*int modbus_report_slave_id(modbus_t *'ctx', uint8_t *'dest');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
doc/modbus_set_error_recovery.txt
| @@ -9,8 +9,7 @@ modbus_set_error_recovery - set the error recovery mode | @@ -9,8 +9,7 @@ modbus_set_error_recovery - set the error recovery mode | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*int modbus_set_error_recovery(modbus_t *'ctx', | ||
| 13 | - modbus_error_recovery_mode 'error_recovery');* | 12 | +*int modbus_set_error_recovery(modbus_t *'ctx', modbus_error_recovery_mode 'error_recovery');* |
| 14 | 13 | ||
| 15 | 14 | ||
| 16 | DESCRIPTION | 15 | DESCRIPTION |
doc/modbus_set_slave.txt
| @@ -9,7 +9,7 @@ modbus_set_slave - set slave number in the context | @@ -9,7 +9,7 @@ modbus_set_slave - set slave number in the context | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*int modbus_set_slave(modbus_t *'ctx', int 'slave')* | 12 | +*int modbus_set_slave(modbus_t *'ctx', int 'slave');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
doc/modbus_set_socket.txt
| @@ -9,7 +9,7 @@ modbus_set_socket - set socket of the context | @@ -9,7 +9,7 @@ modbus_set_socket - set socket of the context | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*void modbus_set_socket(modbus_t *'ctx', int 'socket')* | 12 | +*void modbus_set_socket(modbus_t *'ctx', int 'socket');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
doc/modbus_write_and_read_registers.txt
| @@ -9,7 +9,7 @@ modbus_write_and_read_registers - write and read many registers in a single tran | @@ -9,7 +9,7 @@ modbus_write_and_read_registers - write and read many registers in a single tran | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*int modbus_write_and_read_registers(modbus_t *'ctx', int 'write_addr', int 'write_nb', const uint16_t *'src', int 'read_addr', int 'read_nb', const uint16_t *'dest')* | 12 | +*int modbus_write_and_read_registers(modbus_t *'ctx', int 'write_addr', int 'write_nb', const uint16_t *'src', int 'read_addr', int 'read_nb', const uint16_t *'dest');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
doc/modbus_write_bit.txt
| @@ -9,7 +9,7 @@ modbus_write_bit - write a single bit | @@ -9,7 +9,7 @@ modbus_write_bit - write a single bit | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*int modbus_write_bit(modbus_t *'ctx', int 'addr', int 'status')* | 12 | +*int modbus_write_bit(modbus_t *'ctx', int 'addr', int 'status');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
doc/modbus_write_bits.txt
| @@ -9,7 +9,7 @@ modbus_write_bits - write many bits | @@ -9,7 +9,7 @@ modbus_write_bits - write many bits | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*int modbus_write_bits(modbus_t *'ctx', int 'addr', int 'nb', const uint8_t *'src')* | 12 | +*int modbus_write_bits(modbus_t *'ctx', int 'addr', int 'nb', const uint8_t *'src');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
doc/modbus_write_register.txt
| @@ -9,7 +9,7 @@ modbus_write_register - write a single register | @@ -9,7 +9,7 @@ modbus_write_register - write a single register | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*int modbus_write_register(modbus_t *'ctx', int 'addr', int 'value')* | 12 | +*int modbus_write_register(modbus_t *'ctx', int 'addr', int 'value');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |
doc/modbus_write_registers.txt
| @@ -9,7 +9,7 @@ modbus_write_registers - write many registers | @@ -9,7 +9,7 @@ modbus_write_registers - write many registers | ||
| 9 | 9 | ||
| 10 | SYNOPSIS | 10 | SYNOPSIS |
| 11 | -------- | 11 | -------- |
| 12 | -*int modbus_write_registers(modbus_t *'ctx', int 'addr', int 'nb', const uint16_t *'src')* | 12 | +*int modbus_write_registers(modbus_t *'ctx', int 'addr', int 'nb', const uint16_t *'src');* |
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | DESCRIPTION | 15 | DESCRIPTION |