Added note about leaving callback functions properly. #5127
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
Added the alias \callback_note to APIs with a user callback function. The note is brief and refers to a more detail note in a central place, i.e., alias cpp_c_api_note. Fixes issue HDFGroupGH-5089
bmribler
requested review from
lrknox,
derobins,
byrnHDF,
fortnern,
jhendersonHDF,
qkoziol,
vchoi-hdfgroup,
glennsong09,
mattjala and
brtnfld
as code owners
bmribler
added
Component - Documentation
qkoziol
approved these changes
Nov 17, 2024
byrnHDF
approved these changes
Nov 18, 2024
derobins
approved these changes
Nov 18, 2024
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.
Added the alias \callback_note to APIs with a user callback function. The note is brief and refers to a more detail note in a central place, i.e., alias cpp_c_api_note.
The callback_note will be displayed as below:
Clicking on the link in the first note from a doxygen document will display the more detailed note as below:
Fixes issue GH-5089