search

mmomtchev / swig

This is SWIG JavaScript Evolution, a fork of the SWIG project with modern JavaScript/TypeScript support including WASM and async
http://www.swig.org
Other
7 stars 0 forks source link

Support for Doxygen translation #14

Open disog opened 5 months ago

disog commented 5 months ago

Hello there. Thanks for making this project available. I'm using it to port a C+ library to JavaScript Node-API.

One feature I'm missing is the extraction of Doxygen comments found in C++ header files. I'd love to be able to understand how a class works or know the meaning of method parameters (especially when parameter names are not self-explanatory), by looking at the documentation comment.

There is some information on this subject on SWIG documentation, but it seems that currently JavaScript is not supported. Since you're adding TypeScript support, I wonder if this feature can be implemented for TypeScript as well (i.e., generate the declaration file with documentation comments).

mmomtchev commented 5 months ago

Yes, this is definitely planned, but it is a lot of work.