Skip to content

Documentation: fix C++ South plugin signatures involving PLUGIN_HANDLE#1195

Open
mbourhis wants to merge 13 commits intofledge-iot:developfrom
mbourhis:documentation-fix-south-plugin-signatures
Open

Documentation: fix C++ South plugin signatures involving PLUGIN_HANDLE#1195
mbourhis wants to merge 13 commits intofledge-iot:developfrom
mbourhis:documentation-fix-south-plugin-signatures

Conversation

@mbourhis
Copy link

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.

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>
@mbourhis
Copy link
Author

The code source of the examples have also been updated; see:

@mbourhis
Copy link
Author

This PR concerns the 'South plugin' but other documentation pages are also concerned by this 'inconsistency':

@mbourhis
Copy link
Author

Hi @pintomax, @MarkRiddoch

this PR is about the issue #1069,
where some API plugin signatures involving PLUGIN_HANDLE are erroneous.

So, I am looking for a reviewer for this PR.

Thank you.

@mbourhis
Copy link
Author

mbourhis commented Oct 19, 2023

Hi @MarkRiddoch ,

I would like to know if you are ok or not with this commit
and this improvement in the documentation,
because new users who read the docs (readthedocs.io) -like me- may encounter
this subtlety with the "PLUGIN_HANDLE' as "void *".

Thank you.

@ashish-jabble
Copy link
Member

@MarkRiddoch Do we need to merge this into the develop branch?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants