Skip to content

Commit 4ba7da8

Browse files
committed
docs(compiler): fix JSDoc @PARAM errors in checker.ts
Four documentation-only fixes in src/compiler/checker.ts: 1. Fix swapped JSDoc type/name in getAccessibleSymbolChainFromSymbolTable: `@param {ignoreQualification} boolean` → `@param {boolean} ignoreQualification` 2. Fix @PARAM name typo in isSymbolAccessible JSDoc: `shouldComputeAliasToMakeVisible` → `shouldComputeAliasesToMakeVisible` (matches the actual parameter name and description fix: 'mark' → 'marked') 3. Fix stale @PARAM name in getIndexTypeForMappedType JSDoc: `noIndexSignatures` → `indexFlags` (the parameter was renamed but doc was not updated) 4. Remove ghost @PARAM key from copySymbol JSDoc: copySymbol(symbol, meaning) has no `key` parameter; the doc line was left over from an earlier signature. No runtime behaviour is affected.
1 parent 637d574 commit 4ba7da8

1 file changed

Lines changed: 3 additions & 4 deletions

File tree

src/compiler/checker.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5757,7 +5757,7 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
57575757
return result;
57585758

57595759
/**
5760-
* @param {ignoreQualification} boolean Set when a symbol is being looked for through the exports of another symbol (meaning we have a route to qualify it already)
5760+
* @param {boolean} ignoreQualification Set when a symbol is being looked for through the exports of another symbol (meaning we have a route to qualify it already)
57615761
*/
57625762
function getAccessibleSymbolChainFromSymbolTable(symbols: SymbolTable, ignoreQualification?: boolean, isLocalNameLookup?: boolean): Symbol[] | undefined {
57635763
if (!pushIfUnique(visitedSymbolTables!, symbols)) {
@@ -5975,7 +5975,7 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
59755975
* @param symbol a Symbol to check if accessible
59765976
* @param enclosingDeclaration a Node containing reference to the symbol
59775977
* @param meaning a SymbolFlags to check if such meaning of the symbol is accessible
5978-
* @param shouldComputeAliasToMakeVisible a boolean value to indicate whether to return aliases to be mark visible in case the symbol is accessible
5978+
* @param shouldComputeAliasesToMakeVisible a boolean value to indicate whether to return aliases to be marked visible in case the symbol is accessible
59795979
*/
59805980
function isSymbolAccessible(symbol: Symbol | undefined, enclosingDeclaration: Node | undefined, meaning: SymbolFlags, shouldComputeAliasesToMakeVisible: boolean): SymbolAccessibilityResult {
59815981
return isSymbolAccessibleWorker(symbol, enclosingDeclaration, meaning, shouldComputeAliasesToMakeVisible, /*allowModules*/ true);
@@ -18879,7 +18879,7 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
1887918879
* rather than manufacturing the properties. We can't just fetch the `constraintType` since that would ignore mappings
1888018880
* and mapping the `constraintType` directly ignores how mapped types map _properties_ and not keys (thus ignoring subtype
1888118881
* reduction in the constraintType) when possible.
18882-
* @param noIndexSignatures Indicates if _string_ index signatures should be elided. (other index signatures are always reported)
18882+
* @param indexFlags Flags controlling index type resolution; use IndexFlags.NoIndexSignatures to elide string index signatures (other index signatures are always reported)
1888318883
*/
1888418884
function getIndexTypeForMappedType(type: MappedType, indexFlags: IndexFlags) {
1888518885
const typeParameter = getTypeParameterFromMappedType(type);
@@ -49835,7 +49835,6 @@ export function createTypeChecker(host: TypeCheckerHost): TypeChecker {
4983549835
/**
4983649836
* Copy the given symbol into symbol tables if the symbol has the given meaning
4983749837
* and it doesn't already existed in the symbol table
49838-
* @param key a key for storing in symbol table; if undefined, use symbol.name
4983949838
* @param symbol the symbol to be added into symbol table
4984049839
* @param meaning meaning of symbol to filter by before adding to symbol table
4984149840
*/

0 commit comments

Comments
 (0)