Browse Source

Add traling ';' to all synopsises in the documentation

Stéphane Raimbault 13 years ago
parent
commit
c2313dd979

+ 1 - 1
doc/modbus_get_header_length.txt

@@ -9,7 +9,7 @@ modbus_get_header_length - retrieve the current header length
 
 SYNOPSIS
 --------
-*int modbus_get_header_length(*modbus_t 'ctx');*
+*int modbus_get_header_length(modbus_t *'ctx');*
 
 
 DESCRIPTION

+ 1 - 1
doc/modbus_get_socket.txt

@@ -9,7 +9,7 @@ modbus_get_socket - get the current socket of the context
 
 SYNOPSIS
 --------
-*int modbus_get_socket(modbus_t *'ctx')*
+*int modbus_get_socket(modbus_t *'ctx');*
 
 
 DESCRIPTION

+ 1 - 1
doc/modbus_mapping_free.txt

@@ -9,7 +9,7 @@ modbus_mapping_free - free a modbus_mapping_t structure
 
 SYNOPSIS
 --------
-*void modbus_mapping_free(modbus_mapping_t *'mb_mapping')*
+*void modbus_mapping_free(modbus_mapping_t *'mb_mapping');*
 
 
 DESCRIPTION

+ 1 - 1
doc/modbus_mapping_new.txt

@@ -9,7 +9,7 @@ modbus_mapping_new - allocate four arrays of bits and registers
 
 SYNOPSIS
 --------
-*modbus_mapping_t* modbus_mapping_new(int 'nb_bits', int 'nb_input_bits', int 'nb_registers', int 'nb_input_registers')*
+*modbus_mapping_t* modbus_mapping_new(int 'nb_bits', int 'nb_input_bits', int 'nb_registers', int 'nb_input_registers');*
 
 
 DESCRIPTION

+ 1 - 2
doc/modbus_new_rtu.txt

@@ -9,8 +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');*
 
 
 

+ 1 - 1
doc/modbus_read_bits.txt

@@ -9,7 +9,7 @@ modbus_read_bits - read many bits
 
 SYNOPSIS
 --------
-*int modbus_read_bits(modbus_t *'ctx', int 'addr', int 'nb', uint8_t *'dest')*
+*int modbus_read_bits(modbus_t *'ctx', int 'addr', int 'nb', uint8_t *'dest');*
 
 
 DESCRIPTION

+ 1 - 1
doc/modbus_read_input_registers.txt

@@ -9,7 +9,7 @@ modbus_read_input_registers - read many input registers
 
 SYNOPSIS
 --------
-*int modbus_read_input_registers(modbus_t *'ctx', int 'addr', int 'nb', uint16_t *'dest')*
+*int modbus_read_input_registers(modbus_t *'ctx', int 'addr', int 'nb', uint16_t *'dest');*
 
 
 DESCRIPTION

+ 1 - 1
doc/modbus_read_registers.txt

@@ -9,7 +9,7 @@ modbus_read_registers - read many registers
 
 SYNOPSIS
 --------
-*int modbus_read_registers(modbus_t *'ctx', int 'addr', int 'nb', uint16_t *'dest')*
+*int modbus_read_registers(modbus_t *'ctx', int 'addr', int 'nb', uint16_t *'dest');*
 
 
 DESCRIPTION

+ 1 - 1
doc/modbus_report_slave_id.txt

@@ -9,7 +9,7 @@ modbus_report_slave_id - returns a description of the controller
 
 SYNOPSIS
 --------
-*int modbus_report_slave_id(modbus_t *'ctx', uint8_t *'dest')*
+*int modbus_report_slave_id(modbus_t *'ctx', uint8_t *'dest');*
 
 
 DESCRIPTION

+ 1 - 2
doc/modbus_set_error_recovery.txt

@@ -9,8 +9,7 @@ modbus_set_error_recovery - set the error recovery mode
 
 SYNOPSIS
 --------
-*int modbus_set_error_recovery(modbus_t *'ctx',
-                               modbus_error_recovery_mode 'error_recovery');*
+*int modbus_set_error_recovery(modbus_t *'ctx', modbus_error_recovery_mode 'error_recovery');*
 
 
 DESCRIPTION

+ 1 - 1
doc/modbus_set_slave.txt

@@ -9,7 +9,7 @@ modbus_set_slave - set slave number in the context
 
 SYNOPSIS
 --------
-*int modbus_set_slave(modbus_t *'ctx', int 'slave')*
+*int modbus_set_slave(modbus_t *'ctx', int 'slave');*
 
 
 DESCRIPTION

+ 1 - 1
doc/modbus_set_socket.txt

@@ -9,7 +9,7 @@ modbus_set_socket - set socket of the context
 
 SYNOPSIS
 --------
-*void modbus_set_socket(modbus_t *'ctx', int 'socket')*
+*void modbus_set_socket(modbus_t *'ctx', int 'socket');*
 
 
 DESCRIPTION

+ 1 - 1
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
 
 SYNOPSIS
 --------
-*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')*
+*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');*
 
 
 DESCRIPTION

+ 1 - 1
doc/modbus_write_bit.txt

@@ -9,7 +9,7 @@ modbus_write_bit - write a single bit
 
 SYNOPSIS
 --------
-*int modbus_write_bit(modbus_t *'ctx', int 'addr', int 'status')*
+*int modbus_write_bit(modbus_t *'ctx', int 'addr', int 'status');*
 
 
 DESCRIPTION

+ 1 - 1
doc/modbus_write_bits.txt

@@ -9,7 +9,7 @@ modbus_write_bits - write many bits
 
 SYNOPSIS
 --------
-*int modbus_write_bits(modbus_t *'ctx', int 'addr', int 'nb', const uint8_t *'src')*
+*int modbus_write_bits(modbus_t *'ctx', int 'addr', int 'nb', const uint8_t *'src');*
 
 
 DESCRIPTION

+ 1 - 1
doc/modbus_write_register.txt

@@ -9,7 +9,7 @@ modbus_write_register - write a single register
 
 SYNOPSIS
 --------
-*int modbus_write_register(modbus_t *'ctx', int 'addr', int 'value')*
+*int modbus_write_register(modbus_t *'ctx', int 'addr', int 'value');*
 
 
 DESCRIPTION

+ 1 - 1
doc/modbus_write_registers.txt

@@ -9,7 +9,7 @@ modbus_write_registers - write many registers
 
 SYNOPSIS
 --------
-*int modbus_write_registers(modbus_t *'ctx', int 'addr', int 'nb', const uint16_t *'src')*
+*int modbus_write_registers(modbus_t *'ctx', int 'addr', int 'nb', const uint16_t *'src');*
 
 
 DESCRIPTION