From 552694df1154f341956fe6ff941e013469513362 Mon Sep 17 00:00:00 2001 From: icarus Date: Wed, 22 Oct 2025 07:43:12 +0800 Subject: [PATCH] docs(useMermaidFixTool): improve type comments for Input interface Update JSDoc comments to be more descriptive and follow standard conventions --- .../components/CodeToolbar/hooks/useMermaidFixTool.tsx | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/renderer/src/components/CodeToolbar/hooks/useMermaidFixTool.tsx b/src/renderer/src/components/CodeToolbar/hooks/useMermaidFixTool.tsx index 30ed956f45..f0ab199a44 100644 --- a/src/renderer/src/components/CodeToolbar/hooks/useMermaidFixTool.tsx +++ b/src/renderer/src/components/CodeToolbar/hooks/useMermaidFixTool.tsx @@ -41,12 +41,15 @@ const ResultSchema = z.union([ }) ]) +/** + * Input shape for the Mermaid fix prompt. + */ type Input = { - // mermaid 代码 + /** Mermaid diagram code to be fixed */ mermaid: string - // 错误信息 + /** Error message returned by the renderer */ error: string - // 用户语言代码, 如 zh-cn, en-us + /** User’s language code (e.g. zh-cn, en-us) */ lang: string }