Skip to content

Commit 7072976

Browse files
authored
Merge pull request #39 from webpack/fix-class-docs
2 parents 77c650c + 978025f commit 7072976

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

generate-types/index.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -532,7 +532,7 @@ const printError = (diagnostic) => {
532532
/** @typedef {{ type: "typeParameter", name: string, constraint: ts.Type, defaultValue: ts.Type }} ParsedTypeParameterType */
533533
/** @typedef {{ type: "tuple", typeArguments: readonly ts.Type[] }} ParsedTupleType */
534534
/** @typedef {{ type: "interface", symbolName: SymbolName, subtype: "class" | "module" | "literal" | undefined, properties: PropertiesMap, constructors: ParsedSignature[], calls: ParsedSignature[], numberIndex?: ts.Type, stringIndex?: ts.Type, typeParameters?: readonly ts.Type[], baseTypes: readonly ts.Type[], documentation: string }} ParsedInterfaceType */
535-
/** @typedef {{ type: "class" | "typeof class", symbolName: SymbolName, properties: PropertiesMap, staticProperties: PropertiesMap, constructors: ParsedSignature[], numberIndex?: ts.Type, stringIndex?: ts.Type, typeParameters?: readonly ts.Type[], baseType: ts.Type, correspondingType: ts.Type | undefined }} MergedClassType */
535+
/** @typedef {{ type: "class" | "typeof class", symbolName: SymbolName, properties: PropertiesMap, staticProperties: PropertiesMap, constructors: ParsedSignature[], numberIndex?: ts.Type, stringIndex?: ts.Type, typeParameters?: readonly ts.Type[], baseType: ts.Type, correspondingType: ts.Type | undefined, documentation: string }} MergedClassType */
536536
/** @typedef {{ type: "namespace", symbolName: SymbolName, calls: ParsedSignature[], exports: PropertiesMap }} MergedNamespaceType */
537537
/** @typedef {{ type: "reference", target: ts.Type, typeArguments: readonly ts.Type[], typeArgumentsWithoutDefaults: readonly ts.Type[] }} ParsedReferenceType */
538538
/** @typedef {{ type: "union", symbolName: SymbolName, types: ts.Type[], typeParameters?: readonly ts.Type[] }} ParsedUnionType */
@@ -1485,6 +1485,7 @@ const printError = (diagnostic) => {
14851485
stringIndex: instance.stringIndex,
14861486
typeParameters: instance.typeParameters,
14871487
baseType: instance.baseTypes[0],
1488+
documentation: instance.documentation || parsed.documentation,
14881489
};
14891490
parsedCollectedTypes.set(instanceType, {
14901491
type: "class",
@@ -1528,6 +1529,7 @@ const printError = (diagnostic) => {
15281529
stringIndex: parsed.stringIndex,
15291530
typeParameters: parsed.typeParameters,
15301531
baseType: parsed.baseTypes[0],
1532+
documentation: parsed.documentation,
15311533
};
15321534
parsedCollectedTypes.set(type, newParsed);
15331535
}
@@ -2470,7 +2472,7 @@ const printError = (diagnostic) => {
24702472
parsedCollectedTypes.get(classType)
24712473
);
24722474
const typeArgs = new Set(parsed.typeParameters);
2473-
return `declare ${
2475+
return `${parsed.documentation}declare ${
24742476
parsed.constructors.length === 0 ? "abstract class" : "class"
24752477
} ${variable}${
24762478
parsed.typeParameters

0 commit comments

Comments
 (0)