summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/en-us/config.md107
-rw-r--r--doc/pt-br/config.md107
-rw-r--r--doc/zh-cn/config.md107
-rw-r--r--doc/zh-tw/config.md107
-rw-r--r--tools/build-doc.lua25
5 files changed, 289 insertions, 164 deletions
diff --git a/doc/en-us/config.md b/doc/en-us/config.md
index e7c65697..34d7181e 100644
--- a/doc/en-us/config.md
+++ b/doc/en-us/config.md
@@ -26,9 +26,10 @@ string
## enum
-* `"Disable"`: Only shows `function name`.
-* `"Both"`: Shows `function name` and `call snippet`.
-* `"Replace"`: Only shows `call snippet.`
+* ``"Disable"``: Only shows `function name`.
+* ``"Both"``: Shows `function name` and `call snippet`.
+* ``"Replace"``: Only shows `call snippet.`
+
## default
```json
@@ -79,9 +80,10 @@ string
## enum
-* `"Disable"`: Only shows `keyword`.
-* `"Both"`: Shows `keyword` and `syntax snippet`.
-* `"Replace"`: Only shows `syntax snippet`.
+* ``"Disable"``: Only shows `keyword`.
+* ``"Both"``: Shows `keyword` and `syntax snippet`.
+* ``"Replace"``: Only shows `syntax snippet`.
+
## default
```json
@@ -148,9 +150,10 @@ string
## enum
-* `"Enable"`: Always show context words in suggestions.
-* `"Fallback"`: Contextual words are only displayed when suggestions based on semantics cannot be provided.
-* `"Disable"`: Do not display context words.
+* ``"Enable"``: Always show context words in suggestions.
+* ``"Fallback"``: Contextual words are only displayed when suggestions based on semantics cannot be provided.
+* ``"Disable"``: Do not display context words.
+
## default
```json
@@ -249,9 +252,10 @@ string
## enum
-* `"Enable"`: Always diagnose these files.
-* `"Opened"`: Only when these files are opened will it be diagnosed.
-* `"Disable"`: These files are not diagnosed.
+* ``"Enable"``: Always diagnose these files.
+* ``"Opened"``: Only when these files are opened will it be diagnosed.
+* ``"Disable"``: These files are not diagnosed.
+
## default
```json
@@ -270,9 +274,10 @@ string
## enum
-* `"Enable"`: Always diagnose these files.
-* `"Opened"`: Only when these files are opened will it be diagnosed.
-* `"Disable"`: These files are not diagnosed.
+* ``"Enable"``: Always diagnose these files.
+* ``"Opened"``: Only when these files are opened will it be diagnosed.
+* ``"Disable"``: These files are not diagnosed.
+
## default
```json
@@ -294,9 +299,10 @@ object<string, string>
## enum
-* `"Any"`
-* `"Opened"`
-* `"None"`
+* ``"Any"``
+* ``"Opened"``
+* ``"None"``
+
## default
```json
@@ -360,10 +366,11 @@ object<string, string>
## enum
-* `"Error"`
-* `"Warning"`
-* `"Information"`
-* `"Hint"`
+* ``"Error"``
+* ``"Warning"``
+* ``"Information"``
+* ``"Hint"``
+
## default
```json
@@ -491,9 +498,10 @@ string
## enum
-* `"Enable"`: Show hints in all tables.
-* `"Auto"`: Show hints only when the table is greater than 3 items, or the table is a mixed table.
-* `"Disable"`: Disable hints of array index.
+* ``"Enable"``: Show hints in all tables.
+* ``"Auto"``: Show hints only when the table is greater than 3 items, or the table is a mixed table.
+* ``"Disable"``: Disable hints of array index.
+
## default
```json
@@ -544,9 +552,10 @@ string
## enum
-* `"All"`: All types of parameters are shown.
-* `"Literal"`: Only literal type parameters are shown.
-* `"Disable"`: Disable parameter hints.
+* ``"All"``: All types of parameters are shown.
+* ``"Literal"``: Only literal type parameters are shown.
+* ``"Disable"``: Disable parameter hints.
+
## default
```json
@@ -730,9 +739,10 @@ object<string, string>
## enum
-* `"default"`
-* `"enable"`
-* `"disable"`
+* ``"default"``
+* ``"enable"``
+* ``"disable"``
+
## default
```json
@@ -767,10 +777,11 @@ string
## enum
-* `"utf8"`
-* `"ansi"`
-* `"utf16le"`
-* `"utf16be"`
+* ``"utf8"``
+* ``"ansi"``
+* ``"utf16le"``
+* ``"utf16be"``
+
## default
```json
@@ -803,6 +814,21 @@ Supports non-standard symbols. Make sure that your runtime environment supports
Array<string>
```
+## enum
+
+* ``"//"``
+* ``"/**/"``
+* ``"`"``
+* ``"+="``
+* ``"-="``
+* ``"*="``
+* ``"/="``
+* ``"||"``
+* ``"&&"``
+* ``"!"``
+* ``"!="``
+* ``"continue"``
+
## default
```json
@@ -912,11 +938,12 @@ string
## enum
-* `"Lua 5.1"`
-* `"Lua 5.2"`
-* `"Lua 5.3"`
-* `"Lua 5.4"`
-* `"LuaJIT"`
+* ``"Lua 5.1"``
+* ``"Lua 5.2"``
+* ``"Lua 5.3"``
+* ``"Lua 5.4"``
+* ``"LuaJIT"``
+
## default
```json
diff --git a/doc/pt-br/config.md b/doc/pt-br/config.md
index e7c65697..34d7181e 100644
--- a/doc/pt-br/config.md
+++ b/doc/pt-br/config.md
@@ -26,9 +26,10 @@ string
## enum
-* `"Disable"`: Only shows `function name`.
-* `"Both"`: Shows `function name` and `call snippet`.
-* `"Replace"`: Only shows `call snippet.`
+* ``"Disable"``: Only shows `function name`.
+* ``"Both"``: Shows `function name` and `call snippet`.
+* ``"Replace"``: Only shows `call snippet.`
+
## default
```json
@@ -79,9 +80,10 @@ string
## enum
-* `"Disable"`: Only shows `keyword`.
-* `"Both"`: Shows `keyword` and `syntax snippet`.
-* `"Replace"`: Only shows `syntax snippet`.
+* ``"Disable"``: Only shows `keyword`.
+* ``"Both"``: Shows `keyword` and `syntax snippet`.
+* ``"Replace"``: Only shows `syntax snippet`.
+
## default
```json
@@ -148,9 +150,10 @@ string
## enum
-* `"Enable"`: Always show context words in suggestions.
-* `"Fallback"`: Contextual words are only displayed when suggestions based on semantics cannot be provided.
-* `"Disable"`: Do not display context words.
+* ``"Enable"``: Always show context words in suggestions.
+* ``"Fallback"``: Contextual words are only displayed when suggestions based on semantics cannot be provided.
+* ``"Disable"``: Do not display context words.
+
## default
```json
@@ -249,9 +252,10 @@ string
## enum
-* `"Enable"`: Always diagnose these files.
-* `"Opened"`: Only when these files are opened will it be diagnosed.
-* `"Disable"`: These files are not diagnosed.
+* ``"Enable"``: Always diagnose these files.
+* ``"Opened"``: Only when these files are opened will it be diagnosed.
+* ``"Disable"``: These files are not diagnosed.
+
## default
```json
@@ -270,9 +274,10 @@ string
## enum
-* `"Enable"`: Always diagnose these files.
-* `"Opened"`: Only when these files are opened will it be diagnosed.
-* `"Disable"`: These files are not diagnosed.
+* ``"Enable"``: Always diagnose these files.
+* ``"Opened"``: Only when these files are opened will it be diagnosed.
+* ``"Disable"``: These files are not diagnosed.
+
## default
```json
@@ -294,9 +299,10 @@ object<string, string>
## enum
-* `"Any"`
-* `"Opened"`
-* `"None"`
+* ``"Any"``
+* ``"Opened"``
+* ``"None"``
+
## default
```json
@@ -360,10 +366,11 @@ object<string, string>
## enum
-* `"Error"`
-* `"Warning"`
-* `"Information"`
-* `"Hint"`
+* ``"Error"``
+* ``"Warning"``
+* ``"Information"``
+* ``"Hint"``
+
## default
```json
@@ -491,9 +498,10 @@ string
## enum
-* `"Enable"`: Show hints in all tables.
-* `"Auto"`: Show hints only when the table is greater than 3 items, or the table is a mixed table.
-* `"Disable"`: Disable hints of array index.
+* ``"Enable"``: Show hints in all tables.
+* ``"Auto"``: Show hints only when the table is greater than 3 items, or the table is a mixed table.
+* ``"Disable"``: Disable hints of array index.
+
## default
```json
@@ -544,9 +552,10 @@ string
## enum
-* `"All"`: All types of parameters are shown.
-* `"Literal"`: Only literal type parameters are shown.
-* `"Disable"`: Disable parameter hints.
+* ``"All"``: All types of parameters are shown.
+* ``"Literal"``: Only literal type parameters are shown.
+* ``"Disable"``: Disable parameter hints.
+
## default
```json
@@ -730,9 +739,10 @@ object<string, string>
## enum
-* `"default"`
-* `"enable"`
-* `"disable"`
+* ``"default"``
+* ``"enable"``
+* ``"disable"``
+
## default
```json
@@ -767,10 +777,11 @@ string
## enum
-* `"utf8"`
-* `"ansi"`
-* `"utf16le"`
-* `"utf16be"`
+* ``"utf8"``
+* ``"ansi"``
+* ``"utf16le"``
+* ``"utf16be"``
+
## default
```json
@@ -803,6 +814,21 @@ Supports non-standard symbols. Make sure that your runtime environment supports
Array<string>
```
+## enum
+
+* ``"//"``
+* ``"/**/"``
+* ``"`"``
+* ``"+="``
+* ``"-="``
+* ``"*="``
+* ``"/="``
+* ``"||"``
+* ``"&&"``
+* ``"!"``
+* ``"!="``
+* ``"continue"``
+
## default
```json
@@ -912,11 +938,12 @@ string
## enum
-* `"Lua 5.1"`
-* `"Lua 5.2"`
-* `"Lua 5.3"`
-* `"Lua 5.4"`
-* `"LuaJIT"`
+* ``"Lua 5.1"``
+* ``"Lua 5.2"``
+* ``"Lua 5.3"``
+* ``"Lua 5.4"``
+* ``"LuaJIT"``
+
## default
```json
diff --git a/doc/zh-cn/config.md b/doc/zh-cn/config.md
index 43e8986c..71df8f36 100644
--- a/doc/zh-cn/config.md
+++ b/doc/zh-cn/config.md
@@ -26,9 +26,10 @@ string
## enum
-* `"Disable"`: 只显示 `函数名`。
-* `"Both"`: 显示 `函数名` 与 `调用片段`。
-* `"Replace"`: 只显示 `调用片段`。
+* ``"Disable"``: 只显示 `函数名`。
+* ``"Both"``: 显示 `函数名` 与 `调用片段`。
+* ``"Replace"``: 只显示 `调用片段`。
+
## default
```json
@@ -79,9 +80,10 @@ string
## enum
-* `"Disable"`: 只显示 `关键字`。
-* `"Both"`: 显示 `关键字` 与 `语法片段`。
-* `"Replace"`: 只显示 `语法片段`。
+* ``"Disable"``: 只显示 `关键字`。
+* ``"Both"``: 显示 `关键字` 与 `语法片段`。
+* ``"Replace"``: 只显示 `语法片段`。
+
## default
```json
@@ -148,9 +150,10 @@ string
## enum
-* `"Enable"`: 总是在建议中显示上下文单词。
-* `"Fallback"`: 无法根据语义提供建议时才显示上下文单词。
-* `"Disable"`: 不显示上下文单词。
+* ``"Enable"``: 总是在建议中显示上下文单词。
+* ``"Fallback"``: 无法根据语义提供建议时才显示上下文单词。
+* ``"Disable"``: 不显示上下文单词。
+
## default
```json
@@ -249,9 +252,10 @@ string
## enum
-* `"Enable"`: 总是诊断这些文件。
-* `"Opened"`: 只有打开这些文件时才会诊断。
-* `"Disable"`: 不诊断这些文件。
+* ``"Enable"``: 总是诊断这些文件。
+* ``"Opened"``: 只有打开这些文件时才会诊断。
+* ``"Disable"``: 不诊断这些文件。
+
## default
```json
@@ -270,9 +274,10 @@ string
## enum
-* `"Enable"`: 总是诊断这些文件。
-* `"Opened"`: 只有打开这些文件时才会诊断。
-* `"Disable"`: 不诊断这些文件。
+* ``"Enable"``: 总是诊断这些文件。
+* ``"Opened"``: 只有打开这些文件时才会诊断。
+* ``"Disable"``: 不诊断这些文件。
+
## default
```json
@@ -294,9 +299,10 @@ object<string, string>
## enum
-* `"Any"`
-* `"Opened"`
-* `"None"`
+* ``"Any"``
+* ``"Opened"``
+* ``"None"``
+
## default
```json
@@ -360,10 +366,11 @@ object<string, string>
## enum
-* `"Error"`
-* `"Warning"`
-* `"Information"`
-* `"Hint"`
+* ``"Error"``
+* ``"Warning"``
+* ``"Information"``
+* ``"Hint"``
+
## default
```json
@@ -491,9 +498,10 @@ string
## enum
-* `"Enable"`: 所有的表中都提示数组索引。
-* `"Auto"`: 只有表大于3项，或者表是混合类型时才进行提示。
-* `"Disable"`: 禁用数组索引提示。
+* ``"Enable"``: 所有的表中都提示数组索引。
+* ``"Auto"``: 只有表大于3项，或者表是混合类型时才进行提示。
+* ``"Disable"``: 禁用数组索引提示。
+
## default
```json
@@ -544,9 +552,10 @@ string
## enum
-* `"All"`: 所有类型的参数均进行提示。
-* `"Literal"`: 只有字面量类型的参数进行提示。
-* `"Disable"`: 禁用参数提示。
+* ``"All"``: 所有类型的参数均进行提示。
+* ``"Literal"``: 只有字面量类型的参数进行提示。
+* ``"Disable"``: 禁用参数提示。
+
## default
```json
@@ -730,9 +739,10 @@ object<string, string>
## enum
-* `"default"`
-* `"enable"`
-* `"disable"`
+* ``"default"``
+* ``"enable"``
+* ``"disable"``
+
## default
```json
@@ -767,10 +777,11 @@ string
## enum
-* `"utf8"`
-* `"ansi"`
-* `"utf16le"`
-* `"utf16be"`
+* ``"utf8"``
+* ``"ansi"``
+* ``"utf16le"``
+* ``"utf16be"``
+
## default
```json
@@ -803,6 +814,21 @@ string
Array<string>
```
+## enum
+
+* ``"//"``
+* ``"/**/"``
+* ``"`"``
+* ``"+="``
+* ``"-="``
+* ``"*="``
+* ``"/="``
+* ``"||"``
+* ``"&&"``
+* ``"!"``
+* ``"!="``
+* ``"continue"``
+
## default
```json
@@ -912,11 +938,12 @@ string
## enum
-* `"Lua 5.1"`
-* `"Lua 5.2"`
-* `"Lua 5.3"`
-* `"Lua 5.4"`
-* `"LuaJIT"`
+* ``"Lua 5.1"``
+* ``"Lua 5.2"``
+* ``"Lua 5.3"``
+* ``"Lua 5.4"``
+* ``"LuaJIT"``
+
## default
```json
diff --git a/doc/zh-tw/config.md b/doc/zh-tw/config.md
index ef7438c1..c5d16ebf 100644
--- a/doc/zh-tw/config.md
+++ b/doc/zh-tw/config.md
@@ -26,9 +26,10 @@ string
## enum
-* `"Disable"`: 只顯示 `函式名`。
-* `"Both"`: 顯示 `函式名` 與 `呼叫片段`。
-* `"Replace"`: 只顯示 `呼叫片段`。
+* ``"Disable"``: 只顯示 `函式名`。
+* ``"Both"``: 顯示 `函式名` 與 `呼叫片段`。
+* ``"Replace"``: 只顯示 `呼叫片段`。
+
## default
```json
@@ -79,9 +80,10 @@ string
## enum
-* `"Disable"`: 只顯示 `關鍵字`。
-* `"Both"`: 顯示 `關鍵字` 與 `語法片段`。
-* `"Replace"`: 只顯示 `語法片段`。
+* ``"Disable"``: 只顯示 `關鍵字`。
+* ``"Both"``: 顯示 `關鍵字` 與 `語法片段`。
+* ``"Replace"``: 只顯示 `語法片段`。
+
## default
```json
@@ -148,9 +150,10 @@ string
## enum
-* `"Enable"`: 總是在建議中顯示上下文單詞。
-* `"Fallback"`: 無法根據語義提供建議時才顯示上下文單詞。
-* `"Disable"`: 不顯示上下文單詞。
+* ``"Enable"``: 總是在建議中顯示上下文單詞。
+* ``"Fallback"``: 無法根據語義提供建議時才顯示上下文單詞。
+* ``"Disable"``: 不顯示上下文單詞。
+
## default
```json
@@ -249,9 +252,10 @@ string
## enum
-* `"Enable"`: 總是診斷這些檔案。
-* `"Opened"`: 只有打開這些檔案時才會診斷。
-* `"Disable"`: 不診斷這些檔案。
+* ``"Enable"``: 總是診斷這些檔案。
+* ``"Opened"``: 只有打開這些檔案時才會診斷。
+* ``"Disable"``: 不診斷這些檔案。
+
## default
```json
@@ -270,9 +274,10 @@ string
## enum
-* `"Enable"`: 總是診斷這些檔案。
-* `"Opened"`: 只有打開這些檔案時才會診斷。
-* `"Disable"`: 不診斷這些檔案。
+* ``"Enable"``: 總是診斷這些檔案。
+* ``"Opened"``: 只有打開這些檔案時才會診斷。
+* ``"Disable"``: 不診斷這些檔案。
+
## default
```json
@@ -294,9 +299,10 @@ object<string, string>
## enum
-* `"Any"`
-* `"Opened"`
-* `"None"`
+* ``"Any"``
+* ``"Opened"``
+* ``"None"``
+
## default
```json
@@ -360,10 +366,11 @@ object<string, string>
## enum
-* `"Error"`
-* `"Warning"`
-* `"Information"`
-* `"Hint"`
+* ``"Error"``
+* ``"Warning"``
+* ``"Information"``
+* ``"Hint"``
+
## default
```json
@@ -491,9 +498,10 @@ string
## enum
-* `"Enable"`: 所有的表中都提示陣列索引。
-* `"Auto"`: 只有表大於3項，或者表是混合型別時才進行提示。
-* `"Disable"`: 停用陣列索引提示。
+* ``"Enable"``: 所有的表中都提示陣列索引。
+* ``"Auto"``: 只有表大於3項，或者表是混合型別時才進行提示。
+* ``"Disable"``: 停用陣列索引提示。
+
## default
```json
@@ -544,9 +552,10 @@ string
## enum
-* `"All"`: 所有型別的參數均進行提示。
-* `"Literal"`: 只有字面常數型別的參數進行提示。
-* `"Disable"`: 停用參數提示。
+* ``"All"``: 所有型別的參數均進行提示。
+* ``"Literal"``: 只有字面常數型別的參數進行提示。
+* ``"Disable"``: 停用參數提示。
+
## default
```json
@@ -730,9 +739,10 @@ object<string, string>
## enum
-* `"default"`
-* `"enable"`
-* `"disable"`
+* ``"default"``
+* ``"enable"``
+* ``"disable"``
+
## default
```json
@@ -767,10 +777,11 @@ string
## enum
-* `"utf8"`
-* `"ansi"`
-* `"utf16le"`
-* `"utf16be"`
+* ``"utf8"``
+* ``"ansi"``
+* ``"utf16le"``
+* ``"utf16be"``
+
## default
```json
@@ -803,6 +814,21 @@ string
Array<string>
```
+## enum
+
+* ``"//"``
+* ``"/**/"``
+* ``"`"``
+* ``"+="``
+* ``"-="``
+* ``"*="``
+* ``"/="``
+* ``"||"``
+* ``"&&"``
+* ``"!"``
+* ``"!="``
+* ``"continue"``
+
## default
```json
@@ -912,11 +938,12 @@ string
## enum
-* `"Lua 5.1"`
-* `"Lua 5.2"`
-* `"Lua 5.3"`
-* `"Lua 5.4"`
-* `"LuaJIT"`
+* ``"Lua 5.1"``
+* ``"Lua 5.2"``
+* ``"Lua 5.3"``
+* ``"Lua 5.4"``
+* ``"LuaJIT"``
+
## default
```json
diff --git a/tools/build-doc.lua b/tools/build-doc.lua
index 28f29283..7fa56706 100644
--- a/tools/build-doc.lua
+++ b/tools/build-doc.lua
@@ -99,11 +99,12 @@ local function buildEnum(md, lang, conf)
for i, enum in ipairs(conf.enum) do
local desc = getDesc(lang, conf.markdownEnumDescriptions and conf.markdownEnumDescriptions[i])
if desc then
- md:add('md', ('* `%s`: %s'):format(json.encode(enum), desc))
+ md:add('md', ('* ``%s``: %s'):format(json.encode(enum), desc))
else
- md:add('md', ('* `%s`'):format(json.encode(enum)))
+ md:add('md', ('* ``%s``'):format(json.encode(enum)))
end
end
+ md:emptyLine()
return
end
@@ -115,14 +116,30 @@ local function buildEnum(md, lang, conf)
for i, enum in ipairs(first.enum) do
local desc = getDesc(lang, conf.markdownEnumDescriptions and conf.markdownEnumDescriptions[i])
if desc then
- md:add('md', ('* `%s`: %s'):format(json.encode(enum), desc))
+ md:add('md', ('* ``%s``: %s'):format(json.encode(enum), desc))
else
- md:add('md', ('* `%s`'):format(json.encode(enum)))
+ md:add('md', ('* ``%s``'):format(json.encode(enum)))
end
end
+ md:emptyLine()
return
end
end
+
+ if conf.type == 'array' and conf.items.enum then
+ md:add('md', '## enum')
+ md:emptyLine()
+ for i, enum in ipairs(conf.items.enum) do
+ local desc = getDesc(lang, conf.markdownEnumDescriptions and conf.markdownEnumDescriptions[i])
+ if desc then
+ md:add('md', ('* ``%s``: %s'):format(json.encode(enum), desc))
+ else
+ md:add('md', ('* ``%s``'):format(json.encode(enum)))
+ end
+ end
+ md:emptyLine()
+ return
+ end
end
local function buildMarkdown(lang)
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-06 03:44:01 +0000