Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for Doxygen translation #14

Open
dsogari opened this issue Jan 23, 2024 · 1 comment
Open

Support for Doxygen translation #14

dsogari opened this issue Jan 23, 2024 · 1 comment

Comments

@dsogari
Copy link

dsogari commented Jan 23, 2024

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
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants