Add swig option to include doc for java and python wrapper #4080
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
nanangizz
approved these changes
Sep 17, 2024
sauwming
approved these changes
Sep 17, 2024
|
Glad to see i was able to help with supplying the transformation script. It helps on both VSCode and Pycharm. |
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.
This PR will add the option to include the doc from the
C++code to thejavaandpythonwrapper.It is nice to have since on some IDE, the doc will be shown as tooltip information.
Notes:
SWIG 4or laterJavaandPythonPython, the fields doc might get exported as property doc and not shown properly on the tooltip (e.g.: on VS Code). You can use the script in here to transform the doc further.