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

Merge pull request #9 from jonathangjertsen/document-pointer-usage

Browse Source 
Document that the platform configuration and callbacks can be discarded after initialization
This commit is contained in:
Valerio De Benedetto 2022-06-26 09:14:50 +02:00 committed by GitHub
commit 4f6c710835
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
nanomodbus.h
View File

@ -186,7 +186,7 @@ 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.
* @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.
*/ */
@ -197,8 +197,8 @@ nmbs_error nmbs_client_create(nmbs_t* nmbs, const nmbs_platform_conf* platform_c
/** Create a new Modbus server. /** Create a new Modbus server.
* @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.
*/ */