Add swig option to include doc for java and python wrapper

pjsip / pjproject

PJSIP project

http://www.pjsip.org

GNU General Public License v2.0

2.02k stars 771 forks source link

Add swig option to include doc for java and python wrapper #4080

Closed trengginas closed 1 week ago

trengginas commented 2 weeks ago

This PR will add the option to include the doc from the C++ code to the java and python wrapper. It is nice to have since on some IDE, the doc will be shown as tooltip information.

Notes:

Requires SWIG 4 or later
Only supports Java and Python
On Python, 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.

Axiinos commented 2 weeks ago

Glad to see i was able to help with supplying the transformation script.

It helps on both VSCode and Pycharm.