Updated parameter LuaDoc.

6 files changed, 16 insertions, 14 deletions

diff --git a/modules/textadept/adeptsense.lua b/modules/textadept/adeptsense.lua
index 7f042f98..42e57ddf 100644
--- a/modules/textadept/adeptsense.lua
+++ b/modules/textadept/adeptsense.lua
@@ -413,9 +413,10 @@ end
 -- If *symbol* is `sense.syntax.self` and inside a class definition matching
 -- `sense.syntax.class_definition`, that class is returned. Otherwise the
 -- buffer is searched backwards for a type declaration of *symbol* according to
--- the patterns in `sense.syntax.type_declarations`.
+-- the patterns in `sense.syntax.type_declarations` or a type assignment of
+-- *symbol* according to `sense.syntax.type_assignments`.
 -- @param sense The Adeptsense returned by `adeptsense.new()`.
--- @param symbol The symbol to get the class of.
+-- @param symbol The symbol name to get the class of.
 -- @return class or `nil`
 -- @see syntax
 -- @name get_class
@@ -508,7 +509,7 @@ end
 -- Returns a list of function (unless *only_fields* is `true`) and field (unless
 -- *only_funcs* is `true`) completions for *symbol* name.
 -- @param sense The Adeptsense returned by `adeptsense.new()`.
--- @param symbol The symbol to get completions for.
+-- @param symbol The symbol name to get completions for.
 -- @param only_fields Optional flag indicating whether or not to return a list
 --   of only fields. The default value is `false`.
 -- @param only_functions Optional flag indicating whether or not to return a
@@ -626,8 +627,8 @@ end
 -- Returns a list of apidocs for *symbol* name.
 -- The list contains a `pos` key with the index of the apidoc to show.
 -- @param sense The Adeptsense returned by `adeptsense.new()`.
--- @param symbol The symbol to get apidocs for.
--- @return apidoc_list or `nil`
+-- @param symbol The symbol name to get apidocs for.
+-- @return list of apidocs or `nil`
 -- @name get_apidoc
 function M.get_apidoc(sense, symbol)
   if not symbol then return nil end
@@ -665,7 +666,7 @@ local apidocs = nil
 -- If documentation is already being shown, cycles through multiple definitions.
 -- @param sense The Adeptsense returned by `adeptsense.new()`. If `nil`, uses
 --   the current language's Adeptsense (if it exists).
--- @return list of api docs on success or `nil`.
+-- @return list of apidocs on success or `nil`.
 -- @see get_symbol
 -- @see get_apidoc
 -- @name show_apidoc
@@ -868,7 +869,7 @@ function M.handle_clear(sense) end
 ---
 -- Creates and returns a new Adeptsense for *lang* name.
 -- Only one sense can exist per language.
--- @param lang The lexer language to create an Adeptsense for.
+-- @param lang The lexer language name to create an Adeptsense for.
 -- @return adeptsense
 -- @usage local lua_sense = _M.textadept.adeptsense.new('lua')
 -- @name new
diff --git a/modules/textadept/editing.lua b/modules/textadept/editing.lua
index 0b90369f..604819e6 100644
--- a/modules/textadept/editing.lua
+++ b/modules/textadept/editing.lua
@@ -207,7 +207,7 @@ end
 -- @param word_chars String of characters considered to be part of words. Since
 --   this string is used in a Lua pattern character set, character classes and
 --   ranges may be used.
--- @param default_words Optional list of words considered to be in the document,
+-- @param default_words Optional list of words considered to be in the buffer,
 --   even if they are not. Words may contain [registered images][].
 --
 -- [registered images]: buffer.html#register_image
diff --git a/modules/textadept/find.lua b/modules/textadept/find.lua
index 65ea70ef..ade3fd1b 100644
--- a/modules/textadept/find.lua
+++ b/modules/textadept/find.lua
@@ -93,7 +93,7 @@ local escapes = {
 -- search text and options and prints the results to a buffer.
 -- Use the `find_text`, `match_case`, `whole_word`, and `lua` fields to set the
 -- search text and option flags, respectively.
--- @param utf8_dir Optional UTF-8 encoded directory name to search. If `nil`,
+-- @param utf8_dir Optional UTF-8-encoded directory name to search. If `nil`,
 --   the user is prompted for one.
 -- @name find_in_files
 function find.find_in_files(utf8_dir)
diff --git a/modules/textadept/menu.lua b/modules/textadept/menu.lua
index e224ca82..0ecfc878 100644
--- a/modules/textadept/menu.lua
+++ b/modules/textadept/menu.lua
@@ -297,7 +297,7 @@ end
 -- to call or a table containing a function with its parameters to call when an
 -- item is clicked. Menu items may also be sub-menus, ordered lists of menu
 -- items with an additional `title` key for the sub-menu's title text.
--- @param menubar The table of menus to create the menubar from.
+-- @param menubar The table of menu tables to create the menubar from.
 -- @see gui.menubar
 -- @see gui.menu
 -- @name set_menubar
@@ -321,7 +321,7 @@ M.set_menubar(M.menubar)
 -- a table containing a function with its parameters to call when an item is
 -- clicked. Menu items may also be sub-menus, ordered lists of menu items with
 -- an additional `title` key for the sub-menu's title text.
--- @param menu The menu to create the context menu from.
+-- @param menu The menu table to create the context menu from.
 -- @see gui.context_menu
 -- @see gui.menu
 -- @name set_contextmenu
diff --git a/modules/textadept/run.lua b/modules/textadept/run.lua
index a4089e5a..2fe9f115 100644
--- a/modules/textadept/run.lua
+++ b/modules/textadept/run.lua
@@ -193,7 +193,7 @@ M.error_detail = {}
 -- the error message.
 -- This is typically called by an event handler for when the user double-clicks
 -- on an error message.
--- @param pos The position of the caret.
+-- @param pos The position of the caret in the buffer.
 -- @param line_num The line number the caret is on with the error message.
 -- @see error_detail
 function goto_error(pos, line_num)
diff --git a/modules/textadept/snippets.lua b/modules/textadept/snippets.lua
index 0d85f314..a42cbc75 100644
--- a/modules/textadept/snippets.lua
+++ b/modules/textadept/snippets.lua
@@ -133,8 +133,9 @@ end
 -- Inserts snippet text *text* or the snippet associated with the trigger behind
 -- the caret as a snippet, or goes to the next placeholder of the active
 -- snippet, ultimately only returning `false` if no action was taken.
--- @param text Optional snippet text. If `nil`, attempts to insert a new snippet
---   based on the trigger, the word behind caret, and the current lexer.
+-- @param text Optional snippet text to insert. If `nil`, attempts to insert a
+--   new snippet based on the trigger, the word behind caret, and the current
+--   lexer.
 -- @return `false` if no action was taken; `nil` otherwise.
 -- @see buffer.word_chars
 -- @name _insert