Skip to content

Commit

Permalink
Change style of param jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
remcohaszing committed Apr 29, 2024
1 parent a1e6068 commit 09b4649
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions src/remark-mermaidjs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 09b4649

Please sign in to comment.