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.

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

Make top-level getJSDoc* functions public #18264

Merged
merged 6 commits into from
Sep 19, 2017
Merged

Make top-level getJSDoc* functions public #18264

merged 6 commits into from
Sep 19, 2017

Conversation

sandersn
Copy link
Member

@sandersn sandersn commented Sep 5, 2017 •
edited
Loading

  • getJSDocParameterTags
  • getJSDocAugmentsTag
  • getJSDocClassTag
  • getJSDocClassTag
  • getJSDocTemplateTag
  • getJSDocTypeTag
  • getJSDocReturnTag
  • getJSDocType
  • getJSDocReturnType

Fixes #13498

@sandersn
Make top-level getJSDoc* functions public
56f646e 
* getJSDocParameterTags
* getJSDocAugmentsTag
* getJSDocClassTag
* getJSDocClassTag
* getJSDocTemplateTag
* getJSDocReturnTag
* getJSDocType
* getJSDocReturnType
@sandersn
Copy link
Member Author

sandersn commented Sep 5, 2017

Still needs tests.

Our API tests are basically (semi-)useful samples. @domoritz @navossoc @dmikov @kitsonk do you have realistic samples that would use these functions?

@navossoc
Copy link

navossoc commented Sep 5, 2017

@sandersn

Well, getJsDocTags was used here: https://github.com/YousefED/typescript-json-schema
Doing some special annotations in the comments.

I'm not sure about the status of the project now.
I'm not using it anymore.

Related: YousefED/typescript-json-schema#99

Sorry I can't be of more help.

@domoritz
Copy link

domoritz commented Sep 6, 2017

@novossoc I help maintain that project and also https://github.com/vega/ts-json-schema-generator. It'd be great to generate json schema properties from the jsdocs again.

@sandersn
Copy link
Member Author

sandersn commented Sep 6, 2017

Thanks @domoritz and @navossoc for the links. I included some examples from those two projects.

@sandersn sandersn merged commit 406d9ab into master Sep 19, 2017
@sandersn sandersn deleted the make-jsdoc-getters-public branch September 19, 2017 18:33
@microsoft microsoft locked and limited conversation to collaborators Jun 14, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@weswigham weswigham weswigham approved these changes

@rbuckton rbuckton Awaiting requested review from rbuckton

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@sandersn @navossoc @domoritz @weswigham @msftclas