microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-02-16 05:58:32 -06:00
Code Issues Packages Projects Releases 212 Wiki Activity

Return empty doc comment instead of undefined

Browse Source
This commit is contained in:
uniqueiniquity 2017-10-27 15:33:30 -07:00
parent b5f292d932
commit 22eb519b0f
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/services/jsDoc.ts
View File

@ -188,24 +188,26 @@ namespace ts.JsDoc {
* be performed.
*/
export function getDocCommentTemplateAtPosition(newLine: string, sourceFile: SourceFile, position: number): TextInsertion {
const emptyDocComment = { newText: "", caretOffset: 0 };
// Check if in a context where we don't want to perform any insertion
if (isInString(sourceFile, position) || isInComment(sourceFile, position) || hasDocComment(sourceFile, position)) {
return undefined;
return emptyDocComment;
}
const tokenAtPos = getTokenAtPosition(sourceFile, position, /*includeJsDocComment*/ false);
const tokenStart = tokenAtPos.getStart();
if (!tokenAtPos || tokenStart < position) {
return undefined;
return emptyDocComment;
}
const commentOwnerInfo = getCommentOwnerInfo(tokenAtPos);
if (!commentOwnerInfo) {
return undefined;
return emptyDocComment;
}
const { commentOwner, parameters } = commentOwnerInfo;
if (commentOwner.getStart() < position) {
return undefined;
return emptyDocComment;
}
const posLineAndChar = sourceFile.getLineAndCharacterOfPosition(position);