From dc2f6fb64c4a48c2e1247de2c5411c5bcc10dfd4 Mon Sep 17 00:00:00 2001 From: Thomas Date: Fri, 1 Oct 2021 16:54:10 +0200 Subject: [PATCH] fix(docs): fix docs generation for method return values (#3064) The `@returns` tags were ignored in JSDocs. When `@return` was used, the tag object wasn't properly converted to a string resulting in the output `[object Object]`. Allow both `@returns` and `@return` to be used, and properly stringify their contents. --- src/compiler/docs/generate-doc-data.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/compiler/docs/generate-doc-data.ts b/src/compiler/docs/generate-doc-data.ts index b64572ea894..530bb39ce48 100644 --- a/src/compiler/docs/generate-doc-data.ts +++ b/src/compiler/docs/generate-doc-data.ts @@ -199,7 +199,10 @@ const getDocsMethods = (methods: d.ComponentCompilerMethod[]): d.JsonDocsMethod[ name: member.name, returns: { type: member.complexType.return, - docs: member.docs.tags.filter((t) => t.name === 'return').join('\n'), + docs: member.docs.tags + .filter((t) => t.name === 'return' || t.name === 'returns') + .map((t) => t.text) + .join('\n'), }, signature: `${member.name}${member.complexType.signature}`, parameters: [], // TODO