CC-Tweaked

mirrors/CC-Tweaked

Fork 0

mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-14 13:54:52 +00:00

Commit Graph

Author	SHA1	Message	Date
SquidDev	eead8b5755	A small amount of Lua documentation I'd forgotten how tedious this was. I can't say any of these docs are especially good, but it's something.	2020-04-18 21:42:59 +01:00
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

Author

SHA1

Message

Date

SquidDev

eead8b5755

A small amount of Lua documentation

I'd forgotten how tedious this was. I can't say any of these docs are
especially good, but it's something.

2020-04-18 21:42:59 +01:00

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

2 Commits