Skip to content

fix(generation): fix class jsdoc generation #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
avivkeller merged 1 commit into from
May 23, 2026
+4 −2
Merged

fix(generation): fix class jsdoc generation #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions generate-types/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,7 +532,7 @@ const printError = (diagnostic) => {
/** @typedef {{ type: "typeParameter", name: string, constraint: ts.Type, defaultValue: ts.Type }} ParsedTypeParameterType */
/** @typedef {{ type: "tuple", typeArguments: readonly ts.Type[] }} ParsedTupleType */
/** @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 */
/** @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 */
/** @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 */
/** @typedef {{ type: "namespace", symbolName: SymbolName, calls: ParsedSignature[], exports: PropertiesMap }} MergedNamespaceType */
/** @typedef {{ type: "reference", target: ts.Type, typeArguments: readonly ts.Type[], typeArgumentsWithoutDefaults: readonly ts.Type[] }} ParsedReferenceType */
/** @typedef {{ type: "union", symbolName: SymbolName, types: ts.Type[], typeParameters?: readonly ts.Type[] }} ParsedUnionType */
Expand Down Expand Up @@ -1485,6 +1485,7 @@ const printError = (diagnostic) => {
stringIndex: instance.stringIndex,
typeParameters: instance.typeParameters,
baseType: instance.baseTypes[0],
documentation: instance.documentation || parsed.documentation,
};
parsedCollectedTypes.set(instanceType, {
type: "class",
Expand Down Expand Up @@ -1528,6 +1529,7 @@ const printError = (diagnostic) => {
stringIndex: parsed.stringIndex,
typeParameters: parsed.typeParameters,
baseType: parsed.baseTypes[0],
documentation: parsed.documentation,
};
parsedCollectedTypes.set(type, newParsed);
}
Expand Down Expand Up @@ -2470,7 +2472,7 @@ const printError = (diagnostic) => {
parsedCollectedTypes.get(classType)
);
const typeArgs = new Set(parsed.typeParameters);
return `declare ${
return `${parsed.documentation}declare ${
parsed.constructors.length === 0 ? "abstract class" : "class"
} ${variable}${
parsed.typeParameters
Expand Down
Loading