Improve readability of types and names

sandersn · sandersn · commit ab84cd064771 · 2016-11-18T15:03:40.000-08:00
diff --git a/src/compiler/checker.ts b/src/compiler/checker.ts
@@ -4854,7 +4854,7 @@ namespace ts {
                 if (node.type && node.type.kind === SyntaxKind.JSDocOptionalType) {
                     return true;
                 }
-                const paramTags = getJSDocParameterTag(node);
+                const paramTags = getJSDocParameterTags(node);
                 if (paramTags) {
                     for (const paramTag of paramTags) {
                         if (paramTag.isBracketed) {
diff --git a/src/compiler/types.ts b/src/compiler/types.ts
@@ -498,7 +498,7 @@ namespace ts {
         /* @internal */ original?: Node;                // The original node if this is an updated node.
         /* @internal */ startsOnNewLine?: boolean;      // Whether a synthesized node should start on a new line (used by transforms).
         /* @internal */ jsDocComments?: JSDoc[];        // JSDoc for the node, if it has any.
-        /* @internal */ jsDocCache?: (JSDoc | JSDocParameterTag)[]; // JSDoc for the node, plus JSDoc retrieved from its parents
+        /* @internal */ jsDocCache?: (JSDoc | JSDocTag)[]; // JSDoc for the node, plus JSDoc and tags retrieved from its parents
         /* @internal */ symbol?: Symbol;                // Symbol declared by node (initialized by binding)
         /* @internal */ locals?: SymbolTable;           // Locals associated with node (initialized by binding)
         /* @internal */ nextContainer?: Node;           // Next container in declaration order (initialized by binding)
diff --git a/src/compiler/utilities.ts b/src/compiler/utilities.ts
@@ -1427,7 +1427,7 @@ namespace ts {
             for (const doc of docs) {
                 if (doc.kind === SyntaxKind.JSDocParameterTag) {
                     if (doc.kind === kind) {
-                        result.push(doc as JSDocParameterTag);
+                        result.push(doc as JSDocTag);
                     }
                 }
                 else {
@@ -1442,8 +1442,8 @@ namespace ts {
         return node && firstOrUndefined(getJSDocTags(node, kind));
     }
 
-   function getJSDocs(node: Node): (JSDoc | JSDocParameterTag)[] {
-        let cache: (JSDoc | JSDocParameterTag)[] = node.jsDocCache;
+   function getJSDocs(node: Node): (JSDoc | JSDocTag)[] {
+        let cache: (JSDoc | JSDocTag)[] = node.jsDocCache;
         if (!cache) {
             getJSDocsWorker(node);
             node.jsDocCache = cache;
@@ -1491,7 +1491,7 @@ namespace ts {
 
             // Pull parameter comments from declaring function as well
             if (node.kind === SyntaxKind.Parameter) {
-                cache = concatenate(cache, getJSDocParameterTag(node));
+                cache = concatenate(cache, getJSDocParameterTags(node));
             }
 
             if (isVariableLike(node) && node.initializer) {
@@ -1502,7 +1502,7 @@ namespace ts {
         }
     }
 
-    export function getJSDocParameterTag(param: Node): JSDocParameterTag[] {
+    export function getJSDocParameterTags(param: Node): JSDocParameterTag[] {
         if (!isParameter(param)) {
             return undefined;
         }
@@ -1530,7 +1530,7 @@ namespace ts {
     export function getJSDocType(node: Node): JSDocType {
         let tag: JSDocTypeTag | JSDocParameterTag = getFirstJSDocTag(node, SyntaxKind.JSDocTypeTag) as JSDocTypeTag;
         if (!tag && node.kind === SyntaxKind.Parameter) {
-            const paramTags = getJSDocParameterTag(node);
+            const paramTags = getJSDocParameterTags(node);
             if (paramTags) {
                 tag = find(paramTags, tag => !!tag.typeExpression);
             }
@@ -1558,7 +1558,7 @@ namespace ts {
     export function isRestParameter(node: ParameterDeclaration) {
         if (node && (node.flags & NodeFlags.JavaScriptFile)) {
             if (node.type && node.type.kind === SyntaxKind.JSDocVariadicType ||
-                forEach(getJSDocParameterTag(node),
+                forEach(getJSDocParameterTags(node),
                         t => t.typeExpression && t.typeExpression.type.kind === SyntaxKind.JSDocVariadicType)) {
                 return true;
             }

Original file line number	Diff line number	Diff line change
`@@ -4854,7 +4854,7 @@ namespace ts {`
`4854`	`4854`	`if (node.type && node.type.kind === SyntaxKind.JSDocOptionalType) {`
`4855`	`4855`	`return true;`
`4856`	`4856`	`}`
`4857`		`- const paramTags = getJSDocParameterTag(node);`
	`4857`	`+ const paramTags = getJSDocParameterTags(node);`
`4858`	`4858`	`if (paramTags) {`
`4859`	`4859`	`for (const paramTag of paramTags) {`
`4860`	`4860`	`if (paramTag.isBracketed) {`
Original file line number	Diff line number	Diff line change
`@@ -1427,7 +1427,7 @@ namespace ts {`
`1427`	`1427`	`for (const doc of docs) {`
`1428`	`1428`	`if (doc.kind === SyntaxKind.JSDocParameterTag) {`
`1429`	`1429`	`if (doc.kind === kind) {`
`1430`		`- result.push(doc as JSDocParameterTag);`
	`1430`	`+ result.push(doc as JSDocTag);`
`1431`	`1431`	`}`
`1432`	`1432`	`}`
`1433`	`1433`	`else {`
`@@ -1442,8 +1442,8 @@ namespace ts {`
`1442`	`1442`	`return node && firstOrUndefined(getJSDocTags(node, kind));`
`1443`	`1443`	`}`
`1444`	`1444`
`1445`		`- function getJSDocs(node: Node): (JSDoc \| JSDocParameterTag)[] {`
`1446`		`- let cache: (JSDoc \| JSDocParameterTag)[] = node.jsDocCache;`
	`1445`	`+ function getJSDocs(node: Node): (JSDoc \| JSDocTag)[] {`
	`1446`	`+ let cache: (JSDoc \| JSDocTag)[] = node.jsDocCache;`
`1447`	`1447`	`if (!cache) {`
`1448`	`1448`	`getJSDocsWorker(node);`
`1449`	`1449`	`node.jsDocCache = cache;`
`@@ -1491,7 +1491,7 @@ namespace ts {`
`1491`	`1491`
`1492`	`1492`	`// Pull parameter comments from declaring function as well`
`1493`	`1493`	`if (node.kind === SyntaxKind.Parameter) {`
`1494`		`- cache = concatenate(cache, getJSDocParameterTag(node));`
	`1494`	`+ cache = concatenate(cache, getJSDocParameterTags(node));`
`1495`	`1495`	`}`
`1496`	`1496`
`1497`	`1497`	`if (isVariableLike(node) && node.initializer) {`
`@@ -1502,7 +1502,7 @@ namespace ts {`
`1502`	`1502`	`}`
`1503`	`1503`	`}`
`1504`	`1504`
`1505`		`- export function getJSDocParameterTag(param: Node): JSDocParameterTag[] {`
	`1505`	`+ export function getJSDocParameterTags(param: Node): JSDocParameterTag[] {`
`1506`	`1506`	`if (!isParameter(param)) {`
`1507`	`1507`	`return undefined;`
`1508`	`1508`	`}`
`@@ -1530,7 +1530,7 @@ namespace ts {`
`1530`	`1530`	`export function getJSDocType(node: Node): JSDocType {`
`1531`	`1531`	`let tag: JSDocTypeTag \| JSDocParameterTag = getFirstJSDocTag(node, SyntaxKind.JSDocTypeTag) as JSDocTypeTag;`
`1532`	`1532`	`if (!tag && node.kind === SyntaxKind.Parameter) {`
`1533`		`- const paramTags = getJSDocParameterTag(node);`
	`1533`	`+ const paramTags = getJSDocParameterTags(node);`
`1534`	`1534`	`if (paramTags) {`
`1535`	`1535`	`tag = find(paramTags, tag => !!tag.typeExpression);`
`1536`	`1536`	`}`
`@@ -1558,7 +1558,7 @@ namespace ts {`
`1558`	`1558`	`export function isRestParameter(node: ParameterDeclaration) {`
`1559`	`1559`	`if (node && (node.flags & NodeFlags.JavaScriptFile)) {`
`1560`	`1560`	`if (node.type && node.type.kind === SyntaxKind.JSDocVariadicType \|\|`
`1561`		`- forEach(getJSDocParameterTag(node),`
	`1561`	`+ forEach(getJSDocParameterTags(node),`
`1562`	`1562`	`t => t.typeExpression && t.typeExpression.type.kind === SyntaxKind.JSDocVariadicType)) {`
`1563`	`1563`	`return true;`
`1564`	`1564`	`}`