docs(ngcc): tidy up typos etc in comments (#36989)

This file had a few small typos and other issues that have
now been fixed in this commit.............................

PR Close #36989
This commit is contained in:
Pete Bacon Darwin 2020-05-12 08:20:01 +01:00 committed by Kara Erickson
parent 0672a0e547
commit 2486db7c2b
1 changed files with 8 additions and 6 deletions

View File

@ -25,9 +25,11 @@ export interface ExportStatement extends ts.ExpressionStatement {
} }
/** /**
* A CommonJS or UMD re-export statement. * A CommonJS or UMD wildcard re-export statement.
* *
* In CommonJS/UMD, re-export statements can have several forms (depending, for example, on whether * The CommonJS or UMD version of `export * from 'blah';`.
*
* These statements can have several forms (depending, for example, on whether
* the TypeScript helpers are imported or emitted inline). The expression can have one of the * the TypeScript helpers are imported or emitted inline). The expression can have one of the
* following forms: * following forms:
* - `__export(firstArg)` * - `__export(firstArg)`
@ -35,7 +37,7 @@ export interface ExportStatement extends ts.ExpressionStatement {
* - `tslib.__export(firstArg, exports)` * - `tslib.__export(firstArg, exports)`
* - `tslib.__exportStar(firstArg, exports)` * - `tslib.__exportStar(firstArg, exports)`
* *
* In all cases, we only care about `firstApp`, which is the first argument of the re-export call * In all cases, we only care about `firstArg`, which is the first argument of the re-export call
* expression and can be either a `require('...')` call or an identifier (initialized via a * expression and can be either a `require('...')` call or an identifier (initialized via a
* `require('...')` call). * `require('...')` call).
*/ */
@ -76,7 +78,7 @@ export function findRequireCallReference(id: ts.Identifier, checker: ts.TypeChec
/** /**
* Check whether the specified `ts.Statement` is an export statement, i.e. an expression statement * Check whether the specified `ts.Statement` is an export statement, i.e. an expression statement
* of the form: `export.<foo> = <bar>` * of the form: `exports.<foo> = <bar>`
*/ */
export function isExportStatement(stmt: ts.Statement): stmt is ExportStatement { export function isExportStatement(stmt: ts.Statement): stmt is ExportStatement {
return ts.isExpressionStatement(stmt) && ts.isBinaryExpression(stmt.expression) && return ts.isExpressionStatement(stmt) && ts.isBinaryExpression(stmt.expression) &&
@ -87,8 +89,8 @@ export function isExportStatement(stmt: ts.Statement): stmt is ExportStatement {
} }
/** /**
* Check whether the specified `ts.Statement` is a re-export statement, i.e. an expression statement * Check whether the specified `ts.Statement` is a wildcard re-export statement.
* of one of the following forms: * I.E. an expression statement of one of the following forms:
* - `__export(<foo>)` * - `__export(<foo>)`
* - `__exportStar(<foo>)` * - `__exportStar(<foo>)`
* - `tslib.__export(<foo>, exports)` * - `tslib.__export(<foo>, exports)`