Export Documentation

⚠️Warning

This 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

Example Markdown

Computer

A computer or turtle wrapped as a peripheral

A computer will have the type computer while a turtle will have the type turtle

---

Official Documentation

getID

functionComputer.getID()
->ID: integer

Get the ID of the computer

@returnID — The ID of the computer

---

Official Documentation

getLabel

functionComputer.getLabel()
->label: string|nil

Get the label of the computer

@returnlabel — The computer's label or nil if it does not have one

---

Official Documentation

isOn

functionComputer.isOn()
->isOn: boolean

Get whether the computer is on or not

@returnisOn — If the computer is on

---

Official Documentation

reboot

functionComputer.reboot()

Reboot or turn on the computer

---

Official Documentation

shutdown

functionComputer.shutdown()

Shutdown the computer

---

Official Documentation

turnOn

functionComputer.turnOn()

Turn the computer on

---

Official Documentation

Steps

1. 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.

2. From the bin directory, run ./lua-language-server.exe --doc"<PROJECT_PATH>".

3. Find doc.json and doc.md in log location (sumneko.lua-XXXX/server/log).