From 53f1998261f50e7491efcb731bd86abae04ded14 Mon Sep 17 00:00:00 2001
From: JuanZoran <JuanZoran@users.noreply.github.com>
Date: Wed, 15 Mar 2023 12:58:29 +0000
Subject: [PATCH] chore(doc): Auto generate docs

---
 doc/Trans.txt | 156 ++++++++++++++++++++++++++------------------------
 1 file changed, 80 insertions(+), 76 deletions(-)

diff --git a/doc/Trans.txt b/doc/Trans.txt
index 4499ef4..7a00d81 100644
--- a/doc/Trans.txt
+++ b/doc/Trans.txt
@@ -214,87 +214,91 @@ Festival配置(仅针对linux用户) ~
 配置                                               *Trans-trans.nvim-配置*
 
 >lua
-    require'Trans'.setup {
-        view = {
-            i = 'float',
-            n = 'hover',
-            v = 'hover',
-        },
-        hover = {
-            width = 37,
-            height = 27,
-            border = 'rounded',
-            title = vim.fn.has('nvim-0.9') == 1 and {
-                    { '',       'TransTitleRound' },
-                    { ' Trans', 'TransTitle' },
-                    { '',       'TransTitleRound' },
-                } or nil,
-            keymap = {
-                pageup = '[[',
-                pagedown = ']]',
-                pin = '<leader>[',
-                close = '<leader>]',
-                toggle_entry = '<leader>;',
-                play = '_',
+    require'Trans'.setup{
+        ---@type string the directory for database file and password file
+        dir      = os.getenv('HOME') .. '/.vim/dict',
+        ---@type table modeStrategy default strategy for mode
+        strategy = {
+            ---@type { frontend:string, backend:string } fallback strategy for mode
+            default = {
+                frontend = 'hover',
+                backend = '*',
             },
-            animation = {
-                -- open = 'fold',
-                -- close = 'fold',
-                open = 'slid',
-                close = 'slid',
-                interval = 12,
+        },
+        ---@type table<string, TransBackendOpts> fallback backend for mode
+        backend  = {
+            ---@class TransBackendOpts
+            default = {
+                ---@type integer timeout for backend send request
+                timeout = 2000,
             },
-            auto_close_events = {
-                'InsertEnter',
-                'CursorMoved',
-                'BufLeave',
+        },
+        ---@type table frontend options
+        frontend = {
+            ---@class TransFrontendOpts
+            ---@field keymaps table<string, string>
+            default = {
+                ---@type boolean Whether to auto play the audio
+                auto_play = true,
+                border = 'rounded',
+                title = title, -- need nvim-0.9
+                ---@type {open: string | boolean, close: string | boolean, interval: integer} Hover Window Animation
+                animation = {
+                    open = 'slid', -- 'fold', 'slid'
+                    close = 'slid',
+                    interval = 12,
+                },
+            },
+            ---@class TransHoverOpts : TransFrontendOpts
+            hover = {
+                ---@type integer Max Width of Hover Window
+                width             = 37,
+                ---@type integer Max Height of Hover Window
+                height            = 27,
+                ---@type string -- see: /lua/Trans/style/spinner
+                spinner           = 'dots',
+                ---@type string -- TODO :support replace with {{special word}}
+                fallback_message  = '翻译超时或没有找到相关的翻译',
+                auto_resize       = true,
+                padding           = 10, -- padding for hover window width
+                keymaps           = {
+                    -- play         = '_', -- Deprecated
+                    pageup       = '[[',
+                    pagedown     = ']]',
+                    pin          = '<leader>[',
+                    close        = '<leader>]',
+                    toggle_entry = '<leader>;',
+                },
+                ---@type string[] auto close events
+                auto_close_events = {
+                    'InsertEnter',
+                    'CursorMoved',
+                    'BufLeave',
+                },
+                ---@type string[] order to display translate result
+                order             = {
+                    'title',
+                    'tag',
+                    'pos',
+                    'exchange',
+                    'translation',
+                    'definition',
+                },
+                ---@type table<string, string>
+                icon              = {
+                    -- or use emoji
+                    star     = '', -- ⭐
+                    notfound = ' ', -- ❔
+                    yes      = '✔', -- ✔️
+                    no       = '', -- ❌
+                    cell     = '■', -- ■ | □ | ▇ | ▏ ▎ ▍ ▌ ▋ ▊ ▉ █
+                },
             },
-            auto_play = true,
-            timeout = 2000,
-            spinner = 'dots', -- 查看所有样式: /lua/Trans/util/spinner
-            -- spinner = 'moon'
         },
-        order = { -- only work on hover mode
-            'title',
-            'tag',
-            'pos',
-            'exchange',
-            'translation',
-            'definition',
+        style    = {
+            ---@type string global Trans theme [see lua/Trans/style/theme.lua]
+            theme = 'default', -- default | tokyonight | dracula
         },
-        icon = {
-            star = '',
-            notfound = ' ',
-            yes = '✔',
-            no = '',
-            -- --- char: ■ | □ | ▇ | ▏ ▎ ▍ ▌ ▋ ▊ ▉ █
-            -- --- ◖■■■■■■■◗▫◻ ▆ ▆ ▇⃞ ▉⃞
-            cell = '■',
-            -- star = '⭐',
-            -- notfound = '❔',
-            -- yes = '✔️',
-            -- no = '❌'
-        },
-        theme = 'default',
-        dir = vim.fn.expand('$HOME/.vim/dict'),
-        -- float = {
-        --     width = 0.8,
-        --     height = 0.8,
-        --     border = 'rounded',
-        --     keymap = {
-        --         quit = 'q',
-        --     },
-        --     animation = {
-        --         open = 'fold',
-        --         close = 'fold',
-        --         interval = 10,
-        --     },
-        --     tag = {
-        --         wait = '#519aba',
-        --         fail = '#e46876',
-        --         success = '#10b981',
-        --     },
-        -- },
     }
 <