From 09b4649231c37530fdd91d982e8cec0659f95a62 Mon Sep 17 00:00:00 2001 From: Remco Haszing Date: Mon, 29 Apr 2024 15:21:50 +0200 Subject: [PATCH] Change style of param jsdoc --- src/remark-mermaidjs.ts | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/src/remark-mermaidjs.ts b/src/remark-mermaidjs.ts index 34135fd..fa3638b 100644 --- a/src/remark-mermaidjs.ts +++ b/src/remark-mermaidjs.ts @@ -18,18 +18,23 @@ export interface RemarkMermaidOptions /** * Create a fallback node if processing of a mermaid diagram fails. * - * @param node The mdast `code` node that couldn’t be rendered. - * @param error The error message that was thrown. - * @param file The file on which the error occurred. - * @returns A fallback node to render instead of the invalid diagram. If nothing is returned, the - * code block is removed + * @param node + * The mdast `code` node that couldn’t be rendered. + * @param error + * The error message that was thrown. + * @param file + * The file on which the error occurred. + * @returns + * A fallback node to render instead of the invalid diagram. If nothing is returned, the code + * block is removed */ // eslint-disable-next-line @typescript-eslint/no-invalid-void-type errorFallback?: (node: Code, error: string, file: VFile) => BlockContent | undefined | void } /** - * @param options Options that may be used to tweak the output. + * @param options + * Options that may be used to tweak the output. */ const remarkMermaid: Plugin<[RemarkMermaidOptions?], Root> = (options) => { const render = createMermaidRenderer(options)