aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2020-04-16 23:48:49 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2020-04-16 23:48:49 -0400
commit54ce4ac81d315f75a520094b607a4163ee9b58b4 (patch)
treedbe8980b10590e547cab4c8e281bd6d63544e171
parent978e5ba0e70cc5fbfe7575e4b1ac8834ce10f97d (diff)
downloadtextadept-54ce4ac81d315f75a520094b607a4163ee9b58b4.tar.gz
textadept-54ce4ac81d315f75a520094b607a4163ee9b58b4.zip
Updated LuaDoc.
-rw-r--r--core/.buffer.luadoc14
-rw-r--r--core/.ui.dialogs.luadoc10
-rw-r--r--core/file_io.lua6
3 files changed, 14 insertions, 16 deletions
diff --git a/core/.buffer.luadoc b/core/.buffer.luadoc
index f3e91dd9..ba237e25 100644
--- a/core/.buffer.luadoc
+++ b/core/.buffer.luadoc
@@ -198,8 +198,6 @@
-- A line caret.
-- * `buffer.CARETSTYLE_BLOCK`
-- A block caret.
--- * `buffer.CARETSTYLE_BLOCK_ALWAYS`
--- A block caret in both insert and overtype mode.
--
-- Any block setting may be combined with `buffer.CARETSTYLE_BLOCK_AFTER` via
-- bitwise OR (`|`) in order to draw the caret after the end of a selection,
@@ -1002,7 +1000,7 @@
--
-- @field INDIC_HIDDEN (number, Read-only)
--
--- @field INDIC_MAX (number, Read-only)
+-- @field INDICATOR_MAX (number, Read-only)
--
-- @field INDIC_PLAIN (number, Read-only)
--
@@ -2454,8 +2452,8 @@ function paste(buffer) end
---
-- Returns the position of the character after position *pos* (taking multi-byte
--- characters into account), or `buffer.length` if there is no character after
--- *pos*.
+-- characters into account), or `buffer.length + 1` if there is no character
+-- after *pos*.
-- @param buffer A buffer.
-- @param pos The position in *buffer* to get the position after from.
function position_after(buffer, pos) end
@@ -3196,8 +3194,8 @@ function get_lexer(buffer, current) end
function set_lexer(buffer, lexer) end
---
--- Declares the editor theme to be string *name* and (optionally) assigns the
--- properties contained in table *props*.
+-- Sets the buffer's color theme to be string *name* and (optionally) assigns
+-- the properties contained in table *props*.
-- User themes override Textadept's default themes when they have the same name.
-- If *name* contains slashes, it is assumed to be an absolute path to a theme
-- instead of a theme name.
@@ -3270,7 +3268,7 @@ function set_theme(buffer, name, props) end
-- * technology
-- * two_phase_draw
-- * undo_collection
--- * INDIC_CONTAINER
+-- * INDICATOR_CONTAINER
-- * MOD_NORM
-- * CP_UTF8
-- * LASTSTEPINUNDOREDO
diff --git a/core/.ui.dialogs.luadoc b/core/.ui.dialogs.luadoc
index 08a810d1..ac5bb7b5 100644
--- a/core/.ui.dialogs.luadoc
+++ b/core/.ui.dialogs.luadoc
@@ -325,8 +325,8 @@ function filesave(options) end
function textbox(options) end
---
--- Displays a progressbar dialog defined by dialog options table *options* and
--- updates from function *f*.
+-- Displays a progressbar dialog, defined by dialog options table *options*,
+-- that receives updates from function *f*.
-- Returns "stopped" if *options*.`stoppable` is `true` and the user clicked the
-- "Stop" button. Otherwise, returns `nil`.
-- @param options Table of key-value option pairs for the progressbar dialog.
@@ -342,9 +342,9 @@ function textbox(options) end
-- @param f Function repeatedly called to do work and provide progress updates.
-- The function is called without arguments and must return either `nil`,
-- which indicates work is complete, or a progress percentage number in the
--- range 0-100 and optional string text to display (GTK only). If the text
--- is either "stop disable" or "stop enable" and *options*.`stoppable` is
--- `true`, the "Stop" button is disabled or enabled, respectively.
+-- range 0-100 and an optional string to display (GTK only). If the text is
+-- either "stop disable" or "stop enable" and *options*.`stoppable` is `true`,
+-- the "Stop" button is disabled or enabled, respectively.
-- @return nil or "stopped"
-- @usage ui.dialogs.progressbar({stoppable = true},
-- function() if work() then return percent, status else return nil end end)
diff --git a/core/file_io.lua b/core/file_io.lua
index c1996950..7a7d841b 100644
--- a/core/file_io.lua
+++ b/core/file_io.lua
@@ -397,9 +397,9 @@ io.quick_open_filters = {}
-- @param paths Optional string directory path or table of directory paths to
-- search. The default value is the current project's root directory, if
-- available.
--- @param filter Optional filter for files and directories to exclude. The
--- default value is `lfs.default_filter` unless *paths* is a string and a
--- filter for it is defined in `io.quick_open_filters`.
+-- @param filter Optional filter for files and directories to include and/or
+-- exclude. The default value is `lfs.default_filter` unless *paths* is a
+-- string and a filter for it is defined in `io.quick_open_filters`.
-- @param opts Optional table of additional options for
-- `ui.dialogs.filteredlist()`.
-- @usage io.quick_open(buffer.filename:match('^.+/')) -- list all files in the