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

Enable Reify types to have comments associated with them. #26

Closed
aabtop opened this issue Jun 28, 2020 · 1 comment
Closed

Enable Reify types to have comments associated with them. #26

aabtop opened this issue Jun 28, 2020 · 1 comment

Comments

@aabtop
Copy link
Owner

aabtop commented Jun 28, 2020

The Reify interface definition should include support for associating comments with the defined types. This way, code generators can access comment information and include that in the generated files so that the information is available in many different forms.

This would, for example, enable TypeScript and C++ code completion tools to automatically display help text when typing out a function call.

@aabtop
Copy link
Owner Author

aabtop commented Sep 28, 2020

This is done now in 0db5319 . Though, because we use the TypeScript compiler to generate the ".d.ts" files from the original ".ts" files that Reify generates, the comments unfortunately are not currently carried over into the ".d.ts" files.

@aabtop aabtop closed this as completed Sep 28, 2020
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

1 participant