-
-
Notifications
You must be signed in to change notification settings - Fork 319
Export Documentation
⚠️ WarningThis wiki has been replaced by the wiki on our website. This wiki will be removed in the future.
The language server can be used to export documentation of your project as JSON and Markdown.
Example Markdown
A computer or turtle wrapped as a peripheral
A computer will have the type computer
while a turtle will have the type turtle
function Computer.getID()
-> ID: integer
Get the ID of the computer
@return ID
— The ID of the computer
function Computer.getLabel()
-> label: string|nil
Get the label of the computer
@return label
— The computer's label or nil
if it does not have one
function Computer.isOn()
-> isOn: boolean
Get whether the computer is on or not
@return isOn
— If the computer is on
function Computer.reboot()
Reboot or turn on the computer
function Computer.shutdown()
Shutdown the computer
function Computer.turnOn()
Turn the computer on
-
Locate the
lua-language-server.exe
on your computer.- If you use VS Code, it can be found at
C:\Users\<USERNAME>\.vscode\extensions\sumneko.lua-XXXX\server\bin\lua-language-server.exe
.
- If you use VS Code, it can be found at
-
From the
bin
directory, run./lua-language-server.exe --doc"<PROJECT_PATH>"
. -
Find
doc.json
anddoc.md
in log location (sumneko.lua-XXXX/server/log
).