mirror of
https://github.com/Keyslam-Group/Concord.git
synced 2025-09-02 20:33:54 -04:00
Fix broken LDoc tags
This commit is contained in:
parent
69a9e83759
commit
368766bd27
6 changed files with 2 additions and 10 deletions
|
@ -1,3 +1,3 @@
|
|||
project = 'Concord'
|
||||
description = 'A feature-complete ECS library'
|
||||
file = {'lib', exclude = {'lib/type.lua', 'lib/run.lua'}}
|
||||
file = {'src', exclude = {}}
|
|
@ -21,7 +21,6 @@ function Assemblage.new(assemble)
|
|||
end
|
||||
|
||||
--- Assembles an Entity.
|
||||
-- @see Entity:assemble
|
||||
-- @param e Entity to assemble
|
||||
-- @param ... Varargs to pass to the assemble function
|
||||
-- @ return self
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
-- Components
|
||||
--- Components
|
||||
-- Container for registered ComponentClasss
|
||||
|
||||
local PATH = (...):gsub('%.[^%.]+$', '')
|
||||
|
|
|
@ -98,7 +98,6 @@ function Entity:remove(componentClass)
|
|||
end
|
||||
|
||||
--- Assembles an Entity.
|
||||
-- @see Assemblage:assemble
|
||||
-- @param assemblage Assemblage to assemble with
|
||||
-- @param ... Varargs to pass to the Assemblage's assemble function.
|
||||
function Entity:assemble(assemblage, ...)
|
||||
|
|
|
@ -85,7 +85,6 @@ end
|
|||
--- Loads ComponentClasses and puts them in the Components container.
|
||||
-- Accepts a table of paths to files: {"component_1", "component_2", "etc"}
|
||||
-- Accepts a path to a directory with ComponentClasses: "components"
|
||||
--@see Components
|
||||
function Concord.loadComponents(pathOrFiles)
|
||||
load(pathOrFiles, Concord.components)
|
||||
end
|
||||
|
@ -93,7 +92,6 @@ end
|
|||
--- Loads SystemClasses and puts them in the Systems container.
|
||||
-- Accepts a table of paths to files: {"system_1", "system_2", "etc"}
|
||||
-- Accepts a path to a directory with SystemClasses: "systems"
|
||||
--@see Systems
|
||||
function Concord.loadSystems(pathOrFiles)
|
||||
load(pathOrFiles, Concord.systems)
|
||||
end
|
||||
|
@ -101,7 +99,6 @@ end
|
|||
--- Loads Worlds and puts them in the Worlds container.
|
||||
-- Accepts a table of paths to files: {"world_1", "world_2", "etc"}
|
||||
-- Accepts a path to a directory with Worlds: "worlds"
|
||||
--@see Worlds
|
||||
function Concord.loadWorlds(pathOrFiles)
|
||||
load(pathOrFiles, Concord.worlds)
|
||||
end
|
||||
|
@ -109,7 +106,6 @@ end
|
|||
--- Loads Assemblages and puts them in the Assemblages container.
|
||||
-- Accepts a table of paths to files: {"assemblage_1", "assemblage_2", "etc"}
|
||||
-- Accepts a path to a directory with Assemblages: "assemblages"
|
||||
--@see Assemblages
|
||||
function Concord.loadAssemblages(pathOrFiles)
|
||||
load(pathOrFiles, Concord.assemblages)
|
||||
end
|
||||
|
|
|
@ -77,7 +77,6 @@ function World:removeEntity(e)
|
|||
end
|
||||
|
||||
--- Internal: Marks an Entity as dirty.
|
||||
-- @see Entity:__dirty
|
||||
-- @param e Entity to mark as dirty
|
||||
function World:__dirtyEntity(e)
|
||||
if not self.__dirty:has(e) then
|
||||
|
@ -87,7 +86,6 @@ end
|
|||
|
||||
--- Internal: Flushes all changes to Entities.
|
||||
-- This processes all entities. Adding and removing entities, as well as reevaluating dirty entities.
|
||||
-- @see System:__evaluate
|
||||
-- @return self
|
||||
function World:__flush()
|
||||
-- Early out
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue