aboutsummaryrefslogtreecommitdiff
path: root/modules/textadept/run.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2012-10-08 11:40:17 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2012-10-08 11:40:17 -0400
commit91fcdb58bfe43b368f1bf32edc16ed7dba8c40cd (patch)
tree18c64ae98223dbbba9bd56c98906a254c9e20d5e /modules/textadept/run.lua
parent7148f30241c81ce63fde27c230e1d9db02b19822 (diff)
downloadtextadept-91fcdb58bfe43b368f1bf32edc16ed7dba8c40cd.tar.gz
textadept-91fcdb58bfe43b368f1bf32edc16ed7dba8c40cd.zip
Use '@field' LuaDoc for events defined in modules.
Diffstat (limited to 'modules/textadept/run.lua')
-rw-r--r--modules/textadept/run.lua17
1 files changed, 8 insertions, 9 deletions
diff --git a/modules/textadept/run.lua b/modules/textadept/run.lua
index 56fb06c1..c19c681f 100644
--- a/modules/textadept/run.lua
+++ b/modules/textadept/run.lua
@@ -10,23 +10,22 @@ local M = {}
-- extension.
--
-- [language-specific modules]: _M.html#Compile.and.Run
---
--- ## Run Events
---
--- * `_G.events.COMPILE_OUTPUT`
+-- @field _G.events.COMPILE_OUTPUT (string)
-- Called after a compile command is executed.
-- By default, compiler output is printed to the message buffer. To override
-- this behavior, connect to the event with an index of `1` and return `true`.
-- Arguments:
--- * `lexer`: The lexer language.
--- * `output`: The output from the command.
--- * `_G.events.RUN_OUTPUT`
+--
+-- * `lexer`: The lexer language.
+-- * `output`: The output from the command.
+-- @field _G.events.RUN_OUTPUT (string)
-- Called after a run command is executed.
-- By default, output is printed to the message buffer. To override this
-- behavior, connect to the event with an index of `1` and return `true`.
-- Arguments:
--- * `lexer`: The lexer language.
--- * `output`: The output from the command.
+--
+-- * `lexer`: The lexer language.
+-- * `output`: The output from the command.
module('_M.textadept.run')]]
-- Events.