Issue with wiki page "export-docs" about lua-language-server HOT 5 CLOSED

I am unable to replicate this issue. Can you provide more details and the log file? I am going to transfer this issue to the language server repo.

from lua-language-server.

Lua_Vscode_Export_Bug.zip

I've just uploaded with Lua Script used, exported doc both Json and Markdown and Log from Server folder at C:\Users.vscode\extensions\sumneko.lua-3.7.4-win32-x64\server\log

from lua-language-server.

I just tried exporting documentation from your project and receive the functions from SelfPratice.lua. It looks like they are also included in the json and md files that you generated.

The md file that is exported is intended to be an example, with the code to generate it located at /script/cli/doc2md.lua. If you would like to generate a md file that does not contain any built-in libraries, that would need to be done independently using the doc.json file.

Another thing to note is that some of your annotations are not supported by the language server. Annotations always start with 3 hyphens (---), and it uses @return not @treturn

from lua-language-server.

Thanks for the info, just started with Lua so SelfPratice.lua is taken from internet for testing doc alone. Is there a way to avoid other class except the selected class for md file or both? Also doc generation by choosing a folder is possible?

from lua-language-server.

If you are using VS Code, the export command that we have been using is operating on your workspace. When using the language server from the command line, you can use --doc to select any folder.

If you would like the generated documentation to only contain documentation about a single class, you should be able to filter it out of the JSON using doc.uri to look for a specific file path. I would recommend using /script/cli/doc2md.lua as an example.

from lua-language-server.