Commit graph

4 commits

Author SHA1 Message Date
Andrew Minnich
a65f88dd5e make the docs a little nicer
main changes:
- add parameter and return types where applicable
- use @module and @classmod tags at the top of files
- remove some redundant descriptions of return values, especially for functions that return a boolean

recommended next steps:
- more consistent grammar
- add links to classes and functions in descriptions where appropriate
- be consistent about naming Systems vs. SystemClasses and Components vs. ComponentClasses
2020-01-04 10:31:05 -05:00
Tjakka5
90b949f8a5 rename src folder in config.ld 2020-01-04 10:50:41 +01:00
Tjakka5
368766bd27 Fix broken LDoc tags 2020-01-04 01:41:58 +01:00
Josh Perry
67d67aad5f Added docs
* Added a "nothing docstring" at the top of each file we want to generate docs for. We have to do this or ldoc just straight up refuses to generate docs otherwise.
* Fixed up a few incorrect docstrings
* config.ld is the config file for ldoc

These still need some work: a bunch of functions are still undocumented and also: type.lua & run.lua are completely undocumented.
2018-09-25 18:47:20 +01:00