Update wording in comment for nmbs_client_create and nmbs_server_create
This commit is contained in:
parent
3a1170b925
commit
53a6a64f9b
@ -185,9 +185,8 @@ static const uint8_t NMBS_BROADCAST_ADDRESS = 0;
|
||||
|
||||
#ifndef NMBS_CLIENT_DISABLED
|
||||
/** Create a new Modbus client.
|
||||
* The platform configuration struct is copied by value and may be discarded afterwards.
|
||||
* @param nmbs pointer to the nmbs_t instance where the client will be created.
|
||||
* @param platform_conf nmbs_platform_conf struct with platform configuration.
|
||||
* @param platform_conf nmbs_platform_conf struct with platform configuration. It may be discarded after calling this method.
|
||||
*
|
||||
* @return NMBS_ERROR_NONE if successful, NMBS_ERROR_INVALID_ARGUMENT otherwise.
|
||||
*/
|
||||
@ -196,11 +195,10 @@ nmbs_error nmbs_client_create(nmbs_t* nmbs, const nmbs_platform_conf* platform_c
|
||||
|
||||
#ifndef NMBS_SERVER_DISABLED
|
||||
/** Create a new Modbus server.
|
||||
* The platform configuration and callback structs are copied by value and may be discarded afterwards.
|
||||
* @param nmbs pointer to the nmbs_t instance where the client will be created.
|
||||
* @param address_rtu RTU address of this server. Can be 0 if transport is not RTU.
|
||||
* @param platform_conf nmbs_platform_conf struct with platform configuration.
|
||||
* @param callbacks nmbs_callbacks struct with server request callbacks.
|
||||
* @param platform_conf nmbs_platform_conf struct with platform configuration. It may be discarded after calling this method.
|
||||
* @param callbacks nmbs_callbacks struct with server request callbacks. It may be discarded after calling this method.
|
||||
*
|
||||
* @return NMBS_ERROR_NONE if successful, NMBS_ERROR_INVALID_ARGUMENT otherwise.
|
||||
*/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user