1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-06-16 10:09:55 +00:00
CC-Tweaked/src/main/resources/assets/computercraft/lua/rom/apis
Jonathan Coates ef8da8054f
An initial stab at documentation generation (#360)
This adds documentation comments to many of CC's Lua APIs, and
a couple of the Java ones, through the use of stubs. We then
export these to HTML using illuaminate [1] and upload them to our
documentation site [2].

Uploads currently occur on pushes to master and any release/tag. The
site is entirely static - there is no way to switch between versions,
etc... but hopefully we can improve this in the future.

[1]: github.com/SquidDev/illuaminate/
[2]: https://tweaked.cc/
2020-04-10 10:27:53 +01:00
..
command An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
turtle An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
colors.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
colours.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
disk.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
gps.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
help.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
io.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
keys.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
paintutils.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
parallel.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
peripheral.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
rednet.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
settings.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
term.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
textutils.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
vector.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00
window.lua An initial stab at documentation generation (#360) 2020-04-10 10:27:53 +01:00