Documentation fixes. (#1809)

Fix incorrect references.
Simplify references within the same module.
Fix spelling errors and minor code formatting.
This commit is contained in:
TommyC81
2022-10-21 15:52:09 +04:00
committed by GitHub
parent d5e8de4d74
commit 61ea484614
9 changed files with 133 additions and 136 deletions

View File

@@ -157,7 +157,7 @@ local _ClassID = 0
-- self:SmokeBlue()
-- end
--
-- See the @{Event} module for more information about event handling.
-- See the @{Core.Event} module for more information about event handling.
--
-- # 4. Class identification methods.
--
@@ -412,20 +412,20 @@ do -- Event Handling
return _EVENTDISPATCHER
end
--- Get the Class @{Event} processing Priority.
--- Get the Class @{Core.Event} processing Priority.
-- The Event processing Priority is a number from 1 to 10,
-- reflecting the order of the classes subscribed to the Event to be processed.
-- @param #BASE self
-- @return #number The @{Event} processing Priority.
-- @return #number The @{Core.Event} processing Priority.
function BASE:GetEventPriority()
return self._.EventPriority or 5
end
--- Set the Class @{Event} processing Priority.
--- Set the Class @{Core.Event} processing Priority.
-- The Event processing Priority is a number from 1 to 10,
-- reflecting the order of the classes subscribed to the Event to be processed.
-- @param #BASE self
-- @param #number EventPriority The @{Event} processing Priority.
-- @param #number EventPriority The @{Core.Event} processing Priority.
-- @return #BASE self
function BASE:SetEventPriority( EventPriority )
self._.EventPriority = EventPriority