diff options
| author |   mitchell <70453897+667e-11@users.noreply.github.com> | 2011-09-27 21:20:33 -0400 |
|---|---|---|
| committer | mitchell <70453897+667e-11@users.noreply.github.com> | 2011-09-27 21:20:33 -0400 |
| commit | 132e362f44e00cd93e04967efbfc138c53a47ee4 (patch) | |
| tree | 9d68dcdca8d687e922a277f137813a09d9b4b12d /core/events.lua | |
| parent | 43e9f2528415e8f2d43e7ba65f0d4c5b5d5adff4 (diff) | |
| download | textadept-132e362f44e00cd93e04967efbfc138c53a47ee4.tar.gz textadept-132e362f44e00cd93e04967efbfc138c53a47ee4.zip | |
Reformatted some LuaDoc.
Diffstat (limited to 'core/events.lua')
| -rw-r--r-- | core/events.lua | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/core/events.lua b/core/events.lua index a67dde9d..2145bee4 100644 --- a/core/events.lua +++ b/core/events.lua @@ -204,7 +204,7 @@ end --- -- Disconnects a handler function from an event. -- @param event The string event name. --- @param index Index of the handler (returned by events.connect). +-- @param index Index of the handler (returned by `events.connect()`). -- @see connect function disconnect(event, index) if not handlers[event] then return end @@ -216,11 +216,12 @@ local error_emitted = false --- -- Calls all handlers for the given event in sequence (effectively "generating" -- the event). --- If true or false is explicitly returned by any handler, the event is not +-- If `true` or `false` is explicitly returned by any handler, the event is not -- propagated any further; iteration ceases. -- @param event The string event name. -- @param ... Arguments passed to the handler. --- @return true or false if any handler explicitly returned such; nil otherwise. +-- @return `true` or `false` if any handler explicitly returned such; nil +-- otherwise. function emit(event, ...) if not event then error(L('Undefined event name')) end local h = handlers[event] |