CC-Tweaked

History

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
..
test-rom	An initial stab at documentation generation (#360 )	2020-04-10 10:27:53 +01:00

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

test-rom

An initial stab at documentation generation (#360 )

2020-04-10 10:27:53 +01:00