len0rd/Concord
1
0
Fork 0
mirror of https://github.com/Keyslam-Group/Concord.git synced 2025-09-02 20:33:54 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added docs

Browse source 
* 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
Download patch file Download diff file Expand all files Collapse all files

4
lib/entity.lua
View file

@ -1,3 +1,5 @@
--- Entity
local PATH = (...):gsub('%.[^%.]+$', '')
local Type = require(PATH..".type")
@ -87,7 +89,7 @@ function Entity:get(component)
end
--- Returns true if the Entity has the Component.
-- @params component The Component to check against
-- @param component The Component to check against
-- @return True if the entity has the Bag. False otherwise
function Entity:has(component)
if not Type.isComponent(component) then