Use a private TS api to get full comment text. #315
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
evmar
reviewed
Jan 10, 2017
| for (let d of decSym.getDeclarations()) { | ||
| // yuk, getLeadingCommentRangesOfNode is a private API, using it until | ||
| // https://github.com/Microsoft/TypeScript/issues/7393 is resolved. | ||
| // Switch to the TS JSDoc parser in the future to avoid false positives here. |
There was a problem hiding this comment.
See getJSDoc() in tsickle.ts for another approach that doesn't use private API. It's about as long as what you wrote anyway.
There was a problem hiding this comment.
Good call. I didn't realize that some of the utilities.ts functions were exposed.
I decided against extracting into a comment tsickle helper to return JSDoc text, because it is just two calls into the TS apis and I hope we can switch to using the TS JSDoc parser eventually. WDYT?
In TS 2.1 the getDocumentationConent is stripped of jsdoc @ annotations. Passes all tests with 'TEST_FILTER=decorator gulp watch' Closes #313
evmar
approved these changes
Jan 10, 2017
rkirov
added a commit
that referenced
this pull request
Jan 13, 2017
In TS 2.1 the getDocumentationConent is stripped of jsdoc @ annotations. Passes all tests with 'TEST_FILTER=decorator gulp watch' Closes #313
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In TS 2.1 the comment text is stripped of jsdoc @ annotations.
To read the full JSDoc text we temporary use a private API.
Passes all tests with 'TEST_FILTER=decorator gulp watch'
Closes #313