aboutsummaryrefslogtreecommitdiff
path: root/core/file_io.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2007-08-09 03:45:47 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2007-08-09 03:45:47 -0400
commitb708fa97b490c351f237d22397b8b562d7fb9950 (patch)
tree24a9e569d3c82f61ce1c0e274c99f33438aa80a1 /core/file_io.lua
parenta0ae12838a95c88be4ea1ca83af905a25563faff (diff)
downloadtextadept-b708fa97b490c351f237d22397b8b562d7fb9950.tar.gz
textadept-b708fa97b490c351f237d22397b8b562d7fb9950.zip
Added new LuaDoc, updated existing LuaDoc to be more consistent.
Diffstat (limited to 'core/file_io.lua')
-rw-r--r--core/file_io.lua3
1 files changed, 2 insertions, 1 deletions
diff --git a/core/file_io.lua b/core/file_io.lua
index 12fcc3c1..d1909985 100644
--- a/core/file_io.lua
+++ b/core/file_io.lua
@@ -8,7 +8,7 @@ module('textadept.io', package.seeall)
local handlers = textadept.handlers
---
--- [Local] Opens a file or goes to its already open buffer.
+-- [Local function] Opens a file or goes to its already open buffer.
-- @param filename The absolute path to the file to open.
local function open_helper(filename)
if not filename then return end
@@ -255,6 +255,7 @@ end
-- @param word_chars Characters considered to be word characters for
-- determining the identifier to lookup. Its contents should be in Lua
-- pattern format suitable for the character class construct.
+-- @return API table.
-- @usage textadept.io.read_api_file(filename, '%w_')
function read_api_file(filename, word_chars)
local api = {}