Skip to content

怎么使用luals的文档导出功能 #2927

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mc-GrowlR opened this issue Nov 2, 2024 · 0 comments
Open

怎么使用luals的文档导出功能 #2927

Mc-GrowlR opened this issue Nov 2, 2024 · 0 comments

Comments

@Mc-GrowlR
Copy link
Contributor

How are you using the lua-language-server?

Command Line

Which OS are you using?

Windows

What is the issue affecting?

Other

Expected Behaviour

我想要通过这个命令:

 ./lua-language-server.exe --doc="D:/lua/teast1/test.lua" --doc_out_path="D:/lua/teast1"

导出一个lua 文件的代码文档,但是,导出的确实是关于标准库 的代码文档

Actual Behaviour

导出了标准库的代码文档,例如:
图片

Reproduction steps

  1. 新建文件夹和一个示例代码文件:
---@meta

---相加
---@param a integer
---@param b integer
---@return integer
function add(a, b) end
  1. 调用命令:
 ./lua-language-server.exe --doc="D:/lua/teast1/test.lua" --doc_out_path="D:/lua/teast1"
  1. 输出:
root uri = file:///d%3A/lua/teast1/test.lua
Documentation exported:4/204

D:\lua\teast1\doc.json
D:\lua\teast1\doc.md

Additional Notes

导出的两个文件
doc.md
doc.json

Log File

文件日志:
file_d%3A_lua_teast1_test.lua.log

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant