judsonupchurch/nanoMODBUS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update wording in comment for nmbs_client_create and nmbs_server_create

Browse Source
This commit is contained in:
Jonathan Reichelt Gjertsen 2022-06-24 19:06:37 +02:00 committed by GitHub
parent 3a1170b925
commit 53a6a64f9b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
nanomodbus.h
View File

@ -185,9 +185,8 @@ static const uint8_t NMBS_BROADCAST_ADDRESS = 0;
#ifndef NMBS_CLIENT_DISABLED #ifndef NMBS_CLIENT_DISABLED
/** Create a new Modbus client. /** 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 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. * @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 #ifndef NMBS_SERVER_DISABLED
/** Create a new Modbus server. /** 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 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 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 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. * @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. * @return NMBS_ERROR_NONE if successful, NMBS_ERROR_INVALID_ARGUMENT otherwise.
*/ */