Correct documentation on ModbusServer::poll()
#136
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
ModbusServer::poll()
1 function returns anint
, in the docs it said it returned nothing (void
). I have changed the API-documetation to match the actual function declaration and doc-comment.I observed this on the Arduino website.2 I have archived the Reference page with the mistake on Wayback Machine for future reference.3
I don't know if i have made the change in the correct file, but the mistake was the same in it, so I assume it supplies the information for the website.
In case my assumption is true: may i ask why the documentation on the website isn't auto-generated from the doc-comments in the code files?