Added Comments for CppInterOp's Doxygen based documentation #85
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
vgvassilev
reviewed
May 31, 2023
There was a problem hiding this comment.
Here are some comments from my partial review. Perhaps we could use Check instead of Identify.
@sudo-panda, can you go through the documentation and check if it is aligned with the implementation?
vgvassilev
reviewed
Jun 7, 2023
…ation - Added Comments (Function Definitions) for CppInterOp Doxygen documentation - Incorporated minor changes in Interop.cpp and InterOp.h, as suggested in Vassil's review - changes to preamble section reverted - the "this pointer" term reverted - Made sentence openings consistent (e.g., Identifies > Checks) - Executed `git-clang-format` in InterOp.cpp and InterOp.h
|
Squashed last 10 commits and summarized all comments into the last force-push commit, no new changes to the files |
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.
I have added function definitions as Doxygen-style comments, based on the CppInterop information session between Baidyanath and Krishna.
Please review if my understanding was correct in these definitions (since I'm new to the domain).
Requested Reviewers: @vgvassilev @sudo-panda