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

export cargo docs as tsdoc #52

Closed
dakom opened this issue Nov 9, 2021 · 6 comments
Closed

export cargo docs as tsdoc #52

dakom opened this issue Nov 9, 2021 · 6 comments
Labels
enhancement New feature or request

Comments

@dakom
Copy link

dakom commented Nov 9, 2021

this might be too big of an ask... but would be cool =)

@NyxCode
Copy link
Collaborator

NyxCode commented Nov 11, 2021

actually, doc comments (/// something) are just syntactic sugar for #[doc]: https://doc.rust-lang.org/rustdoc/the-doc-attribute.html
If you feel like it, feel free to open a PR. Always happy to help if you've got questions.

@NyxCode NyxCode added the enhancement New feature or request label Nov 21, 2021
@ghost
Copy link

ghost commented Jan 6, 2022

Are there any plans to retain any kind of comments? It helps the front end dev workflow when you don't have to look up the rust type to read any comments about usage, particularly when the files do not site adjacent to one another. Thanks!

@NyxCode
Copy link
Collaborator

NyxCode commented Jan 6, 2022

Are there any plans to retain any kind of comments? It helps the front end dev workflow when you don't have to look up the rust type to read any comments about usage, particularly when the files do not site adjacent to one another. Thanks!

I'd like to implement this feature. I'm currently a bit busy, so If you feel like it, open a PR.
We can only retain doc comments, since normal comments are stripped before proc macros are run.

@ghost
Copy link

ghost commented Jan 6, 2022

Would love to help, but sadly I am in the same boat as you - rather busy right now. Also, have only done basic proc macros a while ago so would be slow going for me. Perhaps when things are a bit quieter I'll take a stab if nobody else gets round to doing it, would be a nice feature to have for bigger projects.

@samestep
Copy link

I might try to take a closer look at this next month; #102 seems related.

@escritorio-gustavo
Copy link
Contributor

Closing this issue in favor of tracking it through #188

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

No branches or pull requests

4 participants