aboutsummaryrefslogtreecommitdiff
path: root/core/file_io.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2009-07-19 17:11:15 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2009-07-19 17:11:15 -0400
commit3a8ba35148bff928929402a9234c4eb6a4cbc937 (patch)
tree7dc54fb56c198098bb0a513b531e32b53cd17f4e /core/file_io.lua
parent20b984c56d7f7115c78ccc35c059c7e9b2384e2d (diff)
downloadtextadept-3a8ba35148bff928929402a9234c4eb6a4cbc937.tar.gz
textadept-3a8ba35148bff928929402a9234c4eb6a4cbc937.zip
Removed [Local {function,table}] documentation from being shown in LuaDoc.
Diffstat (limited to 'core/file_io.lua')
-rw-r--r--core/file_io.lua16
1 files changed, 5 insertions, 11 deletions
diff --git a/core/file_io.lua b/core/file_io.lua
index 56f3777c..aedecbd3 100644
--- a/core/file_io.lua
+++ b/core/file_io.lua
@@ -32,8 +32,7 @@ boms = {
['UTF-32LE'] = string.char(255, 254, 0, 0)
}
----
--- [Local function] Attempt to detect the encoding of the given text.
+-- Attempt to detect the encoding of the given text.
-- @param text Text to determine encoding from.
-- @return encoding string for textadept.iconv() (unless 'binary', indicating a
-- binary file), byte-order mark (BOM) string or nil. If encoding string is
@@ -57,10 +56,7 @@ local function detect_encoding(text)
return nil
end
----
--- [Local table] List of encodings to try to decode files as after UTF-8.
--- @class table
--- @name try_encodings
+-- List of encodings to try to decode files as after UTF-8.
local try_encodings = {
'UTF-8',
'ASCII',
@@ -68,8 +64,7 @@ local try_encodings = {
'MacRoman'
}
----
--- [Local function] Opens a file or goes to its already open buffer.
+-- Opens a file or goes to its already open buffer.
-- @param utf8_filename The absolute path to the file to open. Must be UTF-8
-- encoded.
local function open_helper(utf8_filename)
@@ -338,9 +333,8 @@ function read_api_file(filename, word_chars)
return api
end
----
--- [Local function] Prompts the user to reload the current file if it has been
--- modified outside of Textadept.
+-- Prompts the user to reload the current file if it has been modified outside
+-- of Textadept.
local function update_modified_file()
if not buffer.filename then return end
local utf8_filename = buffer.filename