From 1c8567f1472599fa78462edfcb78d9f306897063 Mon Sep 17 00:00:00 2001 From: Jiralite <33201955+Jiralite@users.noreply.github.com> Date: Mon, 10 Apr 2023 12:59:29 +0100 Subject: [PATCH] feat: Support `@returns` (#9362) Co-authored-by: Noel --- .../src/components/documentation/tsdoc/BlockComment.tsx | 4 ++++ apps/website/src/components/documentation/tsdoc/TSDoc.tsx | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/apps/website/src/components/documentation/tsdoc/BlockComment.tsx b/apps/website/src/components/documentation/tsdoc/BlockComment.tsx index 924b28674..f3fec803a 100644 --- a/apps/website/src/components/documentation/tsdoc/BlockComment.tsx +++ b/apps/website/src/components/documentation/tsdoc/BlockComment.tsx @@ -36,3 +36,7 @@ export function DeprecatedBlock({ children }: PropsWithChildren): JSX.Element { export function SeeBlock({ children }: PropsWithChildren): JSX.Element { return {children}; } + +export function ReturnsBlock({ children }: PropsWithChildren): JSX.Element { + return {children}; +} diff --git a/apps/website/src/components/documentation/tsdoc/TSDoc.tsx b/apps/website/src/components/documentation/tsdoc/TSDoc.tsx index 3f2e471e3..5e73bcf1d 100644 --- a/apps/website/src/components/documentation/tsdoc/TSDoc.tsx +++ b/apps/website/src/components/documentation/tsdoc/TSDoc.tsx @@ -6,7 +6,7 @@ import { Fragment, useCallback, type ReactNode } from 'react'; import { ItemLink } from '../../ItemLink'; import { SyntaxHighlighter } from '../../SyntaxHighlighter'; import { resolveItemURI } from '../util'; -import { DefaultValueBlock, DeprecatedBlock, ExampleBlock, RemarksBlock, SeeBlock } from './BlockComment'; +import { DefaultValueBlock, DeprecatedBlock, ExampleBlock, RemarksBlock, ReturnsBlock, SeeBlock } from './BlockComment'; export function TSDoc({ item, tsdoc }: { item: ApiItem; tsdoc: DocNode }): JSX.Element { const createNode = useCallback( @@ -98,6 +98,7 @@ export function TSDoc({ item, tsdoc }: { item: ApiItem; tsdoc: DocNode }): JSX.E {defaultValueBlock ? ( {createNode(defaultValueBlock.content)} ) : null} + {comment.returnsBlock ? {createNode(comment.returnsBlock.content)} : null} {exampleBlocks.length ? exampleBlocks.map((block, idx) => {createNode(block.content)}) : null}