len0rd/Concord
1
0
Fork 0
mirror of https://github.com/Keyslam-Group/Concord.git synced 2025-09-04 13:23: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/list.lua
View file

@ -1,3 +1,5 @@
--- List
local List = {}
local mt = {__index = List}
@ -66,7 +68,7 @@ end
--- Gets if the List has the object.
-- @param obj The object to search for
-- @param true if the list has the object, false otherwise
-- true if the list has the object, false otherwise
function List:has(obj)
return self.pointers[obj] and true
end