Skip to content

Js docs #430

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

Merged
merged 2 commits into from
Jul 10, 2018
Merged

Js docs #430

merged 2 commits into from
Jul 10, 2018

Conversation

FreeMasen
Copy link
Contributor

@FreeMasen FreeMasen commented Jul 9, 2018

This addresses two of the 3 remaining items in #57, all user exported functions will now be annotated with the JSDoc @param and @returns statements.

Upon further investigation into applying the @constructor statement I discovered that we are still using the class keyword when using no-modules, meaning that this would not be required.

This should effectively close #57 unless we are looking to provide an output that uses the function constructor + prototype syntax.

@FreeMasen
Copy link
Contributor Author

Looks like this is currently breaking the JS formatting due to the JSDoc convention of including type information inside of {}. Since these new lines end with a } they are being incorrectly formatted.

#427 is pending and re-writes the formatting code entirely so I am going to hold out on a fix until that gets merged.

Copy link
Contributor

@alexcrichton alexcrichton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks!

@fitzgen fitzgen merged commit 4293879 into rustwasm:master Jul 10, 2018
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

Successfully merging this pull request may close these issues.

Copy doc comments from Rust to JS
3 participants