Documentation: fix C++ South plugin signatures involving PLUGIN_HANDLE #1195
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix the issue fledge-iot#1069 In the 'plugin_developers_guide/03_south_C_plugins.html' documentation page, the signature of some plugin functions involving PLUGIN_HANDLE is erroneous. According to the definitions of the function pointers about the South plugins ($FLEDGE_ROOT/C/services/south/include/south_plugin.h), fix these signatures. And use the appropriate C++ 'cast' operator, more restrictive and accurate 'cast' operator than the C one, for the 'PLUGIN_HANDLE' object. Signed-off-by: Mikael Bourhis <mikael.bourhis@smile.fr>
|
The code source of the examples have also been updated; see:
|
|
This PR concerns the 'South plugin' but other documentation pages are also concerned by this 'inconsistency':
|
|
this PR is about the issue #1069, So, I am looking for a reviewer for this PR. Thank you. |
|
Hi @MarkRiddoch , I would like to know if you are ok or not with this commit Thank you. |
FlorentP42
approved these changes
Oct 24, 2023
FlorentP42
approved these changes
Oct 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fix the issue #1069
In the 'plugin_developers_guide/03_south_C_plugins.html' documentation page, the signature of some plugin functions involving PLUGIN_HANDLE is erroneous.
According to the definitions of the function pointers about the South plugins ($FLEDGE_ROOT/C/services/south/include/south_plugin.h), fix these signatures.
And use the appropriate C++ 'cast' operator,
more restrictive and accurate 'cast' operator than the C one, for the 'PLUGIN_HANDLE' object.