Updated Luadoc and added extra fields to other modules.

5 files changed, 31 insertions, 34 deletions

diff --git a/modules/textadept/adeptsense.lua b/modules/textadept/adeptsense.lua
index bcd2a03b..82ea7bea 100644
--- a/modules/textadept/adeptsense.lua
+++ b/modules/textadept/adeptsense.lua
@@ -311,16 +311,16 @@ module('_m.textadept.adeptsense', package.seeall)
 --
 -- #### Other Adeptsense Settings
 --
--- * `always_show_globals`: A flag indicating whether or not to include globals
---   in the list of completions offered. Globals are classes, functions, and
---   fields that do not belong to another class. They are contained in
---   `completions['']`. Defaults to true.
+-- * `always_show_globals` [bool]: Include globals in the list of completions
+--   offered. Globals are classes, functions, and fields that do not belong to
+--   another class. They are contained in `completions['']`. The default value
+--   is `true`.
 
 --
 -- ## Settings
 --
--- * `FUNCTIONS`: XPM image for adeptsense functions.
--- * `FIELDS`: XPM image for adeptsense fields.
+-- * `FUNCTIONS` [string]: XPM image for adeptsense functions.
+-- * `FIELDS` [string]: XPM image for adeptsense fields.
 
 local senses = {}
 
diff --git a/modules/textadept/bookmarks.lua b/modules/textadept/bookmarks.lua
index 26cfb09a..7db46b65 100644
--- a/modules/textadept/bookmarks.lua
+++ b/modules/textadept/bookmarks.lua
@@ -9,10 +9,8 @@ module('_m.textadept.bookmarks', package.seeall)
 -- Markdown:
 -- ## Settings
 --
--- * `MARK_BOOKMARK_COLOR`: The [Scintilla color][scintilla_color] used for a
---    bookmarked line.
---
--- [scintilla_color]: http://scintilla.org/ScintillaDoc.html#colour
+-- * `MARK_BOOKMARK_COLOR` [number]: The color used for a bookmarked line in
+--   0xBBGGRR format.
 
 -- settings
 MARK_BOOKMARK_COLOR = 0xC08040
diff --git a/modules/textadept/editing.lua b/modules/textadept/editing.lua
index 64dbae76..557f3be4 100644
--- a/modules/textadept/editing.lua
+++ b/modules/textadept/editing.lua
@@ -11,23 +11,21 @@ module('_m.textadept.editing', package.seeall)
 -- Markdown:
 -- ## Settings
 --
--- * `AUTOPAIR`: Flag indicating whether or not when an opening `(`, `[`, `[`,
---   `"`, or `'` is typed, its closing complement character is automatically
---   inserted.
--- * `HIGHLIGHT_BRACES`: Flag indicating whether or not when the caret is over a
---   brace character (any of the following: `()[]{}<>`), its matching complement
---   brace is highlighted.
--- * `AUTOINDENT`: Flag indicating whether or not when the enter key is pressed,
---   the inserted line has is indented to match the level of indentation of the
---   previous line.
--- * `SAVE_STRIPS_WS`: Flag indicating whether or not to strip trailing
---   whitespace on file save.
--- * `MARK_HIGHLIGHT_BACK`: The [Scintilla color][scintilla_color] used for a
---   line containing a highlighted word.
--- * `INDIC_HIGHLIGHT_BACK`: The [Scintilla color][scintilla_color] used for an
---   indicator for a highlighted word.
--- * `INDIC_HIGHLIGHT_ALPHA`: The transparency used for an indicator for a
---   highlighted word.
+-- * `AUTOPAIR` [bool]: Opening `(`, `[`, `[`, `"`, or `'` characters are
+--   automatically closed. The default value is `true`.
+-- * `HIGHLIGHT_BRACES` [bool]: Highlight matching '()[]{}<>' characters. The
+--   default value is `true`.
+-- * `AUTOINDENT` [bool]: Match the indentation level of the previous line when
+--   pressing the Enter key. The default value is `true`.
+-- * `SAVE_STRIPS_WS` [bool]: Strip trailing whitespace on file save. The
+--   default value is `true`.
+-- * `MARK_HIGHLIGHT_BACK` [number]: The background color used for a line
+--   containing a highlighted word in 0xBBGGRR format.
+-- * `INDIC_HIGHLIGHT_BACK` [number]: The color used for an indicator for a
+--   highlighted word in 0xBBGGRR format.
+-- * `INDIC_HIGHLIGHT_ALPHA` [number]: The alpha transparency value between 0
+--   (transparent) and 255 (opaque) used for an indicator for a highlighted
+--   word. The default value is 100.
 
 -- settings
 AUTOPAIR = true
diff --git a/modules/textadept/session.lua b/modules/textadept/session.lua
index 503ee248..fbda6ae9 100644
--- a/modules/textadept/session.lua
+++ b/modules/textadept/session.lua
@@ -9,10 +9,10 @@ module('_m.textadept.session', package.seeall)
 -- Markdown:
 -- ## Settings
 --
--- * `DEFAULT_SESSION`: The path to the default session file.
--- * `SAVE_ON_QUIT`: Save the session when quitting. Defaults to true and can be
---   disabled by passing the command line switch '-n' or '--nosession' to
---   Textadept.
+-- * `DEFAULT_SESSION` [string]: The path to the default session file.
+-- * `SAVE_ON_QUIT` [bool]: Save the session when quitting. The default value is
+--   `true` and can be disabled by passing the command line switch '-n' or
+--   '--nosession' to Textadept.
 
 -- settings
 DEFAULT_SESSION = _USERHOME..'/session'
diff --git a/modules/textadept/snapopen.lua b/modules/textadept/snapopen.lua
index d1e514a5..a155d74d 100644
--- a/modules/textadept/snapopen.lua
+++ b/modules/textadept/snapopen.lua
@@ -9,9 +9,10 @@ module('_m.textadept.snapopen', package.seeall)
 -- Markdown:
 -- ## Settings
 --
--- * `PATHS`: Table of default UTF-8 paths to search.
--- * `DEFAULT_DEPTH`: Maximum directory depth to search (defaults to 4).
--- * `MAX`: Maximum number of files to list (defaults to 1000).
+-- * `PATHS` [table]: Table of default UTF-8 paths to search.
+-- * `DEFAULT_DEPTH` [number]: Maximum directory depth to search. The default
+--   value is 4.
+-- * `MAX` [number]: Maximum number of files to list. The default value is 1000.
 --
 -- ## Examples
 --