aboutsummaryrefslogtreecommitdiff
path: root/modules/textadept/editing.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2011-06-23 17:33:40 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2011-06-23 17:33:40 -0400
commitc8e1267fb5b5f9215eade1d6a45dd5228b28548b (patch)
treef7df42426ca5631ac6f67e4156d0800c0ff0befb /modules/textadept/editing.lua
parentf4bc26099570801aef5a3f8d589ae0c8688bd448 (diff)
downloadtextadept-c8e1267fb5b5f9215eade1d6a45dd5228b28548b.tar.gz
textadept-c8e1267fb5b5f9215eade1d6a45dd5228b28548b.zip
Updated Luadoc and added extra fields to other modules.
Diffstat (limited to 'modules/textadept/editing.lua')
-rw-r--r--modules/textadept/editing.lua32
1 files changed, 15 insertions, 17 deletions
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