From 5259639c2c7d9d572190f3d081b100b150a5d677 Mon Sep 17 00:00:00 2001 From: iCrawl Date: Wed, 8 Jun 2022 19:12:42 +0200 Subject: [PATCH] fix: doc generation for return types --- packages/docgen/src/types/method.ts | 10 ++++++---- packages/docgen/src/types/typedef.ts | 10 ++++++---- packages/docgen/src/types/var-type.ts | 4 ++-- 3 files changed, 14 insertions(+), 10 deletions(-) diff --git a/packages/docgen/src/types/method.ts b/packages/docgen/src/types/method.ts index 5aaa6c0fc..3043f3f7d 100644 --- a/packages/docgen/src/types/method.ts +++ b/packages/docgen/src/types/method.ts @@ -44,10 +44,12 @@ export class DocumentedMethod extends DocumentedItem new DocumentedParam(p, this.config).serialize()) : undefined, returns: signature.type - ? new DocumentedVarType( - { names: [parseType(signature.type)], description: signature.comment?.returns?.trim() }, - this.config, - ).serialize() + ? [ + new DocumentedVarType( + { names: [parseType(signature.type)], description: signature.comment?.returns?.trim() }, + this.config, + ).serialize(), + ] : undefined, returnsDescription: signature.comment?.returns?.trim(), meta, diff --git a/packages/docgen/src/types/typedef.ts b/packages/docgen/src/types/typedef.ts index 2164b472b..bf056d9f3 100644 --- a/packages/docgen/src/types/typedef.ts +++ b/packages/docgen/src/types/typedef.ts @@ -122,10 +122,12 @@ export class DocumentedTypeDef extends DocumentedItem t.tagName === 'deprecated'), params, returns: sig?.type - ? new DocumentedVarType( - { names: [parseType(sig.type)], description: sig.comment?.returns?.trim() }, - this.config, - ).serialize() + ? [ + new DocumentedVarType( + { names: [parseType(sig.type)], description: sig.comment?.returns?.trim() }, + this.config, + ).serialize(), + ] : undefined, returnsDescription: sig?.comment?.returns?.trim(), }; diff --git a/packages/docgen/src/types/var-type.ts b/packages/docgen/src/types/var-type.ts index 725f88ee6..963cccbc1 100644 --- a/packages/docgen/src/types/var-type.ts +++ b/packages/docgen/src/types/var-type.ts @@ -10,11 +10,11 @@ export class DocumentedVarType extends DocumentedItem { const names = data.names?.map((name) => splitVarName(parseType(name))); if (!data.description && !data.nullable) { - return [names]; + return names; } return { - types: [names], + types: names, description: data.description, nullable: data.nullable, };