Skip to content

Make top-level getJSDoc* functions public#18264

Merged
sandersn merged 6 commits into
masterfrom
make-jsdoc-getters-public
Sep 19, 2017
Merged

Make top-level getJSDoc* functions public#18264
sandersn merged 6 commits into
masterfrom
make-jsdoc-getters-public

Conversation

@sandersn

@sandersn sandersn commented Sep 5, 2017

Copy link
Copy Markdown
Member
  • getJSDocParameterTags
  • getJSDocAugmentsTag
  • getJSDocClassTag
  • getJSDocClassTag
  • getJSDocTemplateTag
  • getJSDocTypeTag
  • getJSDocReturnTag
  • getJSDocType
  • getJSDocReturnType

Fixes #13498

* getJSDocParameterTags
* getJSDocAugmentsTag
* getJSDocClassTag
* getJSDocClassTag
* getJSDocTemplateTag
* getJSDocReturnTag
* getJSDocType
* getJSDocReturnType
@sandersn

sandersn commented Sep 5, 2017

Copy link
Copy Markdown
Member Author

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

navossoc commented Sep 5, 2017

Copy link
Copy Markdown

@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

domoritz commented Sep 6, 2017

Copy link
Copy Markdown

@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

sandersn commented Sep 6, 2017

Copy link
Copy Markdown
Member Author

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.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants