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.
This commit is contained in:
Josh Perry 2018-09-25 18:47:20 +01:00
parent d53a931c3a
commit 67d67aad5f
17 changed files with 2195 additions and 3 deletions

3
config.ld Normal file
View file

@ -0,0 +1,3 @@
project = 'Concord'
description = 'A feature-complete ECS library'
file = {'lib', exclude = {'lib/type.lua', 'lib/run.lua'}}