LuaDoc updates.

5 files changed, 56 insertions, 50 deletions

diff --git a/core/.buffer.luadoc b/core/.buffer.luadoc
index 9e55a48e..990cc2d3 100644
--- a/core/.buffer.luadoc
+++ b/core/.buffer.luadoc
@@ -254,8 +254,8 @@
 --   position.
 -- @field eol_mode (number)
 --   The current end of line mode. Changing the current mode does not convert
---   existing line endings. Use [`buffer:convert_eols()`](#convert_eols) to do
---   so.
+--   existing end of line characters.
+--   Use [`buffer:convert_eols()`](#convert_eols) to do so.
 --
 --   * `buffer.EOL_CRLF`
 --     Carriage return with line feed ("\r\n").
@@ -985,7 +985,7 @@ function auto_c_select(buffer, prefix) end
 -- items are delimited by `buffer.auto_c_separator` characters, using
 -- *len_entered* number of characters behind the caret as the prefix of the word
 -- to autocomplete.
--- The sorted order of *item_list*, `buffer.auto_c_order`, must have already
+-- `buffer.auto_c_order`, the sorted order of *item_list*, must have already
 -- been defined.
 -- @param buffer The buffer.
 -- @param len_entered The number of characters before the caret used to provide
@@ -1211,9 +1211,9 @@ function colourise(buffer, start_pos, end_pos) end
 function contracted_fold_next(buffer, line_start) end
 
 ---
--- Converts all line endings to end of line mode *mode*.
+-- Converts all end of line characters to the ones in end of line mode *mode*.
 -- @param buffer The buffer.
--- @param mode The line ending mode to convert to. Valid values are:
+-- @param mode The end of line mode to convert to. Valid values are:
 --   * `buffer.EOL_CRLF`
 --   * `buffer.EOL_CR`
 --   * `buffer.EOL_LF`
@@ -1222,7 +1222,7 @@ function convert_eols(buffer, mode) end
 ---
 -- Copies the selected text to the clipboard.
 -- Multiple selections are copied in order with no delimiters. Rectangular
--- selections are copied from top to bottom with line ending delimiters. Virtual
+-- selections are copied from top to bottom with end of line characters. Virtual
 -- space is not copied.
 -- @param buffer The buffer.
 function copy(buffer) end
@@ -1261,7 +1261,7 @@ function count_characters(buffer, start_pos, end_pos) end
 ---
 -- Cuts the selected text to the clipboard.
 -- Multiple selections are copied in order with no delimiters. Rectangular
--- selections are copied from top to bottom with line ending delimiters. Virtual
+-- selections are copied from top to bottom with end of line characters. Virtual
 -- space is not copied.
 -- @param buffer The buffer.
 function cut(buffer) end
@@ -1476,7 +1476,7 @@ function get_line_sel_start_position(buffer, line) end
 ---
 -- Returns the selected text.
 -- Multiple selections are included in order with no delimiters. Rectangular
--- selections are included from top to bottom with line ending delimiters.
+-- selections are included from top to bottom with end of line characters.
 -- Virtual space is not included.
 -- @param buffer The buffer.
 -- @return string, number
@@ -1538,13 +1538,13 @@ function home_display_extend(buffer) end
 function home_extend(buffer) end
 
 ---
--- Moves the caret to beginning of the current line, extending the rectangular
--- selection to the new position.
+-- Moves the caret to the beginning of the current line, extending the
+-- rectangular selection to the new position.
 -- @param buffer The buffer.
 function home_rect_extend(buffer) end
 
 ---
--- Moves the caret to beginning of the current wrapped line or, if already
+-- Moves the caret to the beginning of the current wrapped line or, if already
 -- there, to the beginning of the actual line.
 -- @param buffer The buffer.
 function home_wrap(buffer) end
@@ -2121,8 +2121,8 @@ function scroll_to_end(buffer) end
 function scroll_to_start(buffer) end
 
 ---
--- Anchors the position `buffer:search_next()` and `buffer:search_prev()` begin
--- at to the caret position.
+-- Anchors the position that `buffer:search_next()` and `buffer:search_prev()`
+-- begin at to the caret position.
 -- @param buffer The buffer.
 function search_anchor(buffer) end
 
@@ -2435,7 +2435,7 @@ function upper_case(buffer) end
 -- Displays a user list identified by list identifier number *list_item* and
 -- constructed from string *item_list*, whose items are delimited by
 -- `buffer.auto_c_separator` characters.
--- The sorted order of *item_list*, `buffer.auto_c_order`, must have already
+-- `buffer.auto_c_order`, the sorted order of *item_list*, must have already
 -- been defined. When the user selects an item, *list_type* is sent in a
 -- `USER_LIST_SELECTION` event along with the selection.
 -- @param buffer The buffer.
@@ -2542,29 +2542,35 @@ function word_left_end_extend(buffer) end
 function word_left_extend(buffer) end
 
 ---
--- Moves the caret to the previous underscore or change in capitalization within
--- the current word.
+-- Moves the caret to the previous part of the current word.
+-- Word parts are delimited by underscore characters or changes in
+-- capitalization.
 -- `buffer.word_chars` contains word characters.
 -- @param buffer The buffer.
 function word_part_left(buffer) end
 
 ---
--- Moves the caret to the previous underscore or change in capitalization within
--- the current word, extending the selected text to the new position.
+-- Moves the caret to the previous part of the current word, extending the
+-- selected text to the new position.
+-- Word parts are delimited by underscore characters or changes in
+-- capitalization.
 -- `buffer.word_chars` contains word characters.
 -- @param buffer The buffer.
 function word_part_left_extend(buffer) end
 
 ---
--- Moves the caret to the next underscore or change in capitalization within the
--- current word.
+-- Moves the caret to the next part of the current word.
+-- Word parts are delimited by underscore characters or changes in
+-- capitalization.
 -- `buffer.word_chars` contains word characters.
 -- @param buffer The buffer.
 function word_part_right(buffer) end
 
 ---
--- Moves the caret to the next underscore or change in capitalization within the
--- current word, extending the selected text to the new position.
+-- Moves the caret to the next part of the current word, extending the selected
+-- text to the new position.
+-- Word parts are delimited by underscore characters or changes in
+-- capitalization.
 -- `buffer.word_chars` contains word characters.
 -- @param buffer The buffer.
 function word_part_right_extend(buffer) end
diff --git a/core/.iconv.luadoc b/core/.iconv.luadoc
index ee403194..95e62803 100644
--- a/core/.iconv.luadoc
+++ b/core/.iconv.luadoc
@@ -6,7 +6,7 @@
 module('string')
 
 ---
--- Converts string *text* from encoding *from* to encoding *to* using iconv,
+-- Converts string *text* from encoding *old* to encoding *new* using iconv,
 -- returning the string result.
 -- Valid encodings are [GNU iconv's encodings][] and include:
 --
@@ -33,6 +33,6 @@ module('string')
 --
 -- [GNU iconv's encodings]: http://www.gnu.org/software/libiconv/
 -- @param text The text to convert.
--- @param to The string encoding to convert to.
--- @param from The string encoding to convert from.
-function iconv(text, to, from) end
+-- @param new The string encoding to convert to.
+-- @param old The string encoding to convert from.
+function iconv(text, new, old) end
diff --git a/core/.ui.dialogs.luadoc b/core/.ui.dialogs.luadoc
index 91ea5e4c..68c33c3a 100644
--- a/core/.ui.dialogs.luadoc
+++ b/core/.ui.dialogs.luadoc
@@ -303,9 +303,9 @@ function textbox(options) end
 -- options table *options*, returning the selected button's index along with the
 -- index of the selected item or, if *options*.`string_output` is `true`, the
 -- selected button's label along with the selected item's text.
--- If *options*.`exit_onchange` caused the dialog to close, returns `4` along
--- with either the selected item's index or text. If the dialog timed out,
--- returns `0` or `"timeout"`. If the user canceled the dialog, returns `-1` or
+-- If the dialog closed due to *options*.`exit_onchange`, returns `4` along with
+-- either the selected item's index or text. If the dialog timed out, returns
+-- `0` or `"timeout"`. If the user canceled the dialog, returns `-1` or
 -- `"delete"`.
 -- @param options Table of key-value option pairs for the drop down dialog.
 --
@@ -342,9 +342,9 @@ function dropdown(options) end
 -- returning the selected button's index along with the selected item's index
 -- or, if *options*.`string_output` is `true`, the selected button's label along
 -- with the selected item's text.
--- If *options*.`exit_onchange` caused the dialog to close, returns `4` along
--- with either the selected item's index or text. If the dialog timed out,
--- returns `0` or `"timeout"`. If the user canceled the dialog, returns `-1` or
+-- If the dialog closed due to *options*.`exit_onchange`, returns `4` along with
+-- either the selected item's index or text. If the dialog timed out, returns
+-- `0` or `"timeout"`. If the user canceled the dialog, returns `-1` or
 -- `"delete"`.
 -- @param options Table of key-value option pairs for the drop down dialog.
 --
@@ -373,10 +373,10 @@ function standard_dropdown(options) end
 ---
 -- Prompts the user with a filtered list item selection dialog defined by dialog
 -- options table *options*, returning the selected button's index along with the
--- index(es) of the selected item(s) (depending on whether or not
+-- index or indices of the selected item or items (depending on whether or not
 -- *options*.`select_multiple` is `true`) or, if *options*.`string_output` is
--- `true`, the selected button's label along with the selected item's or items'
--- text.
+-- `true`, the selected button's label along with the text of the selected item
+-- or items.
 -- If the dialog timed out, returns `0` or `"timeout"`. If the user canceled the
 -- dialog, returns `-1` or `"delete"`.
 -- Spaces in the filter text are treated as wildcards.
diff --git a/core/events.lua b/core/events.lua
index babc9f0d..20cb6cb9 100644
--- a/core/events.lua
+++ b/core/events.lua
@@ -100,8 +100,8 @@ local M = {}
 --   * _`x`_: The x-coordinate of the mouse in the view.
 --   * _`y`_: The y-coordinate of the mouse in the view.
 -- @field DWELL_START (string)
---   Emitted after keeping the mouse stationary for
---   [`buffer.mouse_dwell_time`][] milliseconds.
+--   Emitted when the mouse is stationary for [`buffer.mouse_dwell_time`][]
+--   milliseconds.
 --   Arguments:
 --
 --   * _`position`_: The position closest to *x* and *y*.
@@ -113,7 +113,7 @@ local M = {}
 --
 --   * _`text`_: The error message text.
 -- @field FIND (string)
---   Emitted to find text via the Find dialog box.
+--   Emitted to find text via the Find & Replace Pane.
 --   Arguments:
 --
 --   * _`text`_: The text to search for.
diff --git a/core/file_io.lua b/core/file_io.lua
index 8e824de2..1a017be7 100644
--- a/core/file_io.lua
+++ b/core/file_io.lua
@@ -8,19 +8,19 @@
 --   Emitted by [`open_file()`](#open_file).
 --   Arguments:
 --
---   * _`filename`_: The filename opened.
+--   * _`filename`_: The opened file's filename.
 -- @field _G.events.FILE_BEFORE_SAVE (string)
 --   Emitted right before saving a file to disk.
 --   Emitted by [`io.save_file()`](#save_file).
 --   Arguments:
 --
---   * _`filename`_: The filename being saved.
+--   * _`filename`_: The filename of the file being saved.
 -- @field _G.events.FILE_AFTER_SAVE (string)
 --   Emitted right after saving a file to disk.
 --   Emitted by [`io.save_file()`](#save_file).
 --   Arguments:
 --
---   * _`filename`_: The filename being saved.
+--   * _`filename`_: The filename of the file being saved.
 -- @field _G.events.FILE_SAVED_AS (string)
 --   Emitted after saving a file under a different filename.
 --   Emitted by [`io.save_file_as()`](#save_file_as).
@@ -28,7 +28,7 @@
 --
 --   * _`filename`_: The new filename.
 -- @field _G.events.FILE_CHANGED (string)
---   Emitted when Textadept detects that a file was externally modified.
+--   Emitted when Textadept detects that an open file was modified externally.
 --   When connecting to this event, connect with an index of 1 to override the
 --   default prompt to reload the file.
 --   Arguments:
@@ -358,14 +358,14 @@ end
 ---
 -- Prompts the user to select files to open from *paths*, a string directory
 -- path or list of directory paths, using a filtered list dialog.
--- Files shown in the dialog do not match any pattern in string or table
--- *filter*, and, unless *exclude_FILTER* is `true`, `lfs.FILTER` as well. A
--- filter table contains Lua patterns that match filenames to exclude, an
--- optional `folders` sub-table that contains patterns matching directories to
--- exclude, and an optional `extensions` sub-table that contains raw file
--- extensions to exclude. Any patterns starting with '!' exclude files and
--- directories that do not match the pattern that follows. The number of files
--- in the list is capped at `SNAPOPEN_MAX`.
+-- Files shown in the dialog do not match any pattern in either string or table
+-- *filter* or, unless *exclude_FILTER* is `true`, in `lfs.FILTER`. A filter
+-- table contains Lua patterns that match filenames to exclude, an optional
+-- `folders` sub-table that contains patterns matching directories to exclude,
+-- and an optional `extensions` sub-table that contains raw file extensions to
+-- exclude. Any patterns starting with '!' exclude files and directories that do
+-- not match the pattern that follows. The number of files in the list is capped
+-- at `SNAPOPEN_MAX`.
 -- *opts* is an optional table of additional options for
 -- `ui.dialogs.filteredlist()`.
 -- @param paths String directory path or table of directory paths to search.