aboutsummaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2009-01-16 09:29:10 -0500
committermitchell <70453897+667e-11@users.noreply.github.com>2009-01-16 09:29:10 -0500
commit7759c62c4e94b213553cf35210ef0197a0ffed8c (patch)
treef0ef91d48e977b517a81587d228bff97f8a97736 /modules
parent86531c680d440f8a936d5cdda93db7a20d64e2e2 (diff)
downloadtextadept-7759c62c4e94b213553cf35210ef0197a0ffed8c.tar.gz
textadept-7759c62c4e94b213553cf35210ef0197a0ffed8c.zip
Updated some LuaDoc; modules/textadept/run.lua
Diffstat (limited to 'modules')
-rw-r--r--modules/textadept/run.lua7
1 files changed, 5 insertions, 2 deletions
diff --git a/modules/textadept/run.lua b/modules/textadept/run.lua
index 822ecb03..23c6d4cf 100644
--- a/modules/textadept/run.lua
+++ b/modules/textadept/run.lua
@@ -6,7 +6,10 @@ local textadept = _G.textadept
-- Module for running/executing source files.
module('_m.textadept.run', package.seeall)
---- [Local function] Prints a command to Textadept.
+---
+-- [Local function] Prints a command to Textadept.
+-- @param cmd The OS command executed.
+-- @param output The output from that OS command.
local function print_command(cmd, output)
textadept.print('> '..cmd..'\n'..output)
buffer:goto_pos(buffer.length)
@@ -16,7 +19,7 @@ end
-- Passes the current file to a specified compiler to run with the given flags
-- and prints the output to Textadept.
-- @param compiler The system's compiler for the file.
--- @param flags A string of flags to pass to the interpreter.
+-- @param cflags A string of flags to pass to the interpreter.
-- @param args Table of arguments key keys as follows:
-- * filename_noext_with_flag The value of this flag passed to the compiler
-- is the filename without its extension.