mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-10-31 23:26:19 +00:00
Code Issues Releases Wiki Activity

Some tiny bits of documentation cleanup

Browse Source 
I'm really good at this English lark :D:.
This commit is contained in:
SquidDev 2020-04-21 12:12:44 +01:00
parent 1fc0214857
commit 3b7b845930
3 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
illuaminate.sexp
View File

@ -59,3 +59,20 @@
(at /doc/stub (at /doc/stub
(linters -var:unused-global) (linters -var:unused-global)
(lint (allow-toplevel-global true))) (lint (allow-toplevel-global true)))
;; Ensure any fully documented modules stay fully documented.
(at
(/src/main/resources/assets/computercraft/lua/rom/apis/colors.lua
/src/main/resources/assets/computercraft/lua/rom/apis/colours.lua
/src/main/resources/assets/computercraft/lua/rom/apis/disk.lua
/src/main/resources/assets/computercraft/lua/rom/apis/gps.lua
/src/main/resources/assets/computercraft/lua/rom/apis/help.lua
/src/main/resources/assets/computercraft/lua/rom/apis/keys.lua
/src/main/resources/assets/computercraft/lua/rom/apis/paintutils.lua
/src/main/resources/assets/computercraft/lua/rom/apis/parallel.lua
/src/main/resources/assets/computercraft/lua/rom/apis/peripheral.lua
/src/main/resources/assets/computercraft/lua/rom/apis/rednet.lua
/src/main/resources/assets/computercraft/lua/rom/apis/settings.lua
/src/main/resources/assets/computercraft/lua/rom/apis/texutils.lua
/src/main/resources/assets/computercraft/lua/rom/apis/vector.lua)
(linters doc:undocumented doc:undocumented-arg))

7
src/main/resources/assets/computercraft/lua/rom/apis/settings.lua
View File

@ -124,7 +124,12 @@ function get(name, default)
end end
end end
--- Get details about a specific setting --- Get details about a specific setting.
--
-- @tparam string name The name of the setting to get.
-- @treturn { description? = string, default? = value, type? = string, value? = value }
-- Information about this setting. This includes all information from @{settings.define},
-- as well as this setting's value.
function getDetails(name) function getDetails(name)
expect(1, name, "string") expect(1, name, "string")
local deets = copy(details[name]) or {} local deets = copy(details[name]) or {}

2
src/main/resources/assets/computercraft/lua/rom/apis/window.lua
View File

@ -445,7 +445,7 @@ function create(parent, nX, nY, nWidth, nHeight, bStartVisible)
-- @treturn string The textual content of this line. -- @treturn string The textual content of this line.
-- @treturn string The text colours of this line, suitable for use with @{term.blit}. -- @treturn string The text colours of this line, suitable for use with @{term.blit}.
-- @treturn string The background colours of this line, suitable for use with @{term.blit}. -- @treturn string The background colours of this line, suitable for use with @{term.blit}.
-- @throws If `y` is a valid line. -- @throws If `y` is not between 1 and this window's height.
function window.getLine(y) function window.getLine(y)
if type(y) ~= "number" then expect(1, y, "number") end if type(y) ~= "number" then expect(1, y, "number") end