Skip to content

Expose jsdoc factory API #29341

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.

Sign up for GitHub

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

Jump to bottom
Closed
Kingwl opened this issue Jan 10, 2019 · 1 comment · Fixed by #29539
Closed

Expose jsdoc factory API #29341

Kingwl opened this issue Jan 10, 2019 · 1 comment · Fixed by #29539
Labels
API Relates to the public API for TypeScript In Discussion Not yet reached consensus Suggestion An idea for TypeScript

Comments

@Kingwl
Copy link
Contributor

Kingwl commented Jan 10, 2019 •
edited
Loading

Search Terms

factory, jsdoc

Suggestion

expose jsdoc API as not internal

Use Cases

I have to work on an API definition generator
And I wanna to generate the jsdoc attach to the Declaration,
But seems there's no way to do that(yet)

BTW: jsdoc API is already existed but marked as internal
@weswigham weswigham added Suggestion An idea for TypeScript In Discussion Not yet reached consensus API Relates to the public API for TypeScript labels Jan 10, 2019
@Kingwl Kingwl mentioned this issue Jan 13, 2019
Open
@Kingwl
Copy link
Contributor Author

Kingwl commented Jan 15, 2019 •
edited
Loading

I'm prefer to provide a special api as:

function attachJSDoc(jsdoc: JSDoc, node: Node): Node {
/// attach jsdoc to node
return node
}

that was helpful to chain factory

@Kingwl Kingwl mentioned this issue Jan 23, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
API Relates to the public API for TypeScript In Discussion Not yet reached consensus Suggestion An idea for TypeScript
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

expose jsdoc factory Kingwl/TypeScript
2 participants
@weswigham @Kingwl