custom luadoc generation

LuaLS · Aug 23, 2024 · aeb9ccb · aeb9ccb
1 parent ba8f90e
commit aeb9ccb
Show file tree

Hide file tree

Showing 11 changed files with 827 additions and 539 deletions.
diff --git a/changelog.md b/changelog.md
@@ -2,6 +2,8 @@
 
 ## Unreleased
 <!-- Add all new changes here. They will be moved under a version at release -->
+* `NEW` Custom documentation exporter
+* `NEW` Setting: `Lua.docScriptPath`: Path to a script that overrides `cli.doc.export`, allowing user-specified documentation exporting.
 
 ## 3.10.5
 `2024-8-19`

diff --git a/locale/en-us/script.lua b/locale/en-us/script.lua
@@ -656,10 +656,10 @@ CLI_DOC_INITING   =
 'Loading documents ...'
 CLI_DOC_DONE      =
 [[
-Document exporting completed!
-Raw data: {}
-Markdown(example): {}
+Documentation exported:
 ]]
+CLI_DOC_WORKING   =
+'Building docs...'
 
 TYPE_ERROR_ENUM_GLOBAL_DISMATCH =
 'Type `{child}` cannot match enumeration type of `{parent}`'

diff --git a/locale/pt-br/script.lua b/locale/pt-br/script.lua
@@ -654,12 +654,10 @@ CLI_CHECK_MULTIPLE_WORKERS = -- TODO: need translate!
 'Starting {} worker tasks, progress output will be disabled. This may take a few minutes.'
 CLI_DOC_INITING   = -- TODO: need translate!
 'Loading documents ...'
-CLI_DOC_DONE      = -- TODO: need translate!
-[[
-Document exporting completed!
-Raw data: {}
-Markdown(example): {}
-]]
+CLI_DOC_DONE      =
+'Documentos exportados:'
+CLI_DOC_WORKING   =
+'Construindo docs...'
 
 TYPE_ERROR_ENUM_GLOBAL_DISMATCH = -- TODO: need translate!
 'Type `{child}` cannot match enumeration type of `{parent}`'

diff --git a/locale/zh-cn/script.lua b/locale/zh-cn/script.lua
@@ -654,12 +654,10 @@ CLI_CHECK_MULTIPLE_WORKERS = -- TODO: need translate!
 'Starting {} worker tasks, progress output will be disabled. This may take a few minutes.'
 CLI_DOC_INITING   =
 '加载文档 ...'
-CLI_DOC_DONE      =
-[[
-文档导出完成！
-原始数据: {}
-Markdown(演示用): {}
-]]
+CLI_DOC_DONE      = -- TODO: need translate!
+'文档导出完成！'
+CLI_DOC_WORKING   =
+'正在生成文档...'
 
 TYPE_ERROR_ENUM_GLOBAL_DISMATCH =
 '类型 `{child}` 无法匹配 `{parent}` 的枚举类型'

diff --git a/locale/zh-tw/script.lua b/locale/zh-tw/script.lua
@@ -655,12 +655,9 @@ CLI_CHECK_MULTIPLE_WORKERS = -- TODO: need translate!
 CLI_DOC_INITING   = -- TODO: need translate!
 'Loading documents ...'
 CLI_DOC_DONE      = -- TODO: need translate!
-[[
-Document exporting completed!
-Raw data: {}
-Markdown(example): {}
-]]
-
+'Document exporting completed!'
+CLI_DOC_WORKING   =
+'正在產生文件...'
 TYPE_ERROR_ENUM_GLOBAL_DISMATCH = -- TODO: need translate!
 'Type `{child}` cannot match enumeration type of `{parent}`'
 TYPE_ERROR_ENUM_GENERIC_UNSUPPORTED = -- TODO: need translate!