aboutsummaryrefslogtreecommitdiff
path: root/modules/textadept/editing.lua
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2012-10-29 20:45:58 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2012-10-29 20:45:58 -0400
commitfa38d2306fadc99bb1403433517ecf45a24062eb (patch)
tree19f286adb6be4cbd7a1b11fc1c880976a01ea9fd /modules/textadept/editing.lua
parent6718de08a3f19f8c24c1c4167b05828a7ac0dfd7 (diff)
downloadtextadept-fa38d2306fadc99bb1403433517ecf45a24062eb.tar.gz
textadept-fa38d2306fadc99bb1403433517ecf45a24062eb.zip
Updated documentation formatting.
Pathnames and filenames are italic and be more consistent with constant width text.
Diffstat (limited to 'modules/textadept/editing.lua')
-rw-r--r--modules/textadept/editing.lua15
1 files changed, 8 insertions, 7 deletions
diff --git a/modules/textadept/editing.lua b/modules/textadept/editing.lua
index 8adff1a1..d61ad7dc 100644
--- a/modules/textadept/editing.lua
+++ b/modules/textadept/editing.lua
@@ -6,12 +6,13 @@ local M = {}
---
-- Editing features for Textadept.
-- @field AUTOPAIR (bool)
--- Opening `(`, `[`, `{`, `"`, or `'` characters are automatically closed.
+-- Opening '(', '[', '{', '&quot;', or '&apos;' characters are automatically
+-- closed.
-- The default value is `true`.
-- Auto-paired characters are defined in the [`char_matches`](#char_matches)
-- table.
-- @field HIGHLIGHT_BRACES (bool)
--- Highlight matching `()[]{}` characters.
+-- Highlight matching "()[]{}" characters.
-- The default value is `true`.
-- Matching braces are defined in the [`braces`](#braces) table.
-- @field AUTOINDENT (bool)
@@ -23,10 +24,10 @@ local M = {}
-- The default value is `true`.
-- @field MARK_HIGHLIGHT_BACK (number)
-- The background color used for a line containing a
--- [highlighted word](#highlight_word) in `0xBBGGRR` format.
+-- [highlighted word](#highlight_word) in "0xBBGGRR" format.
-- @field INDIC_HIGHLIGHT_BACK (number)
-- The color used for an indicator for a [highlighted word](#highlight_word)
--- in `0xBBGGRR` format.
+-- in "0xBBGGRR" format.
-- @field INDIC_HIGHLIGHT_ALPHA (number)
-- The alpha transparency value between `0` (transparent) and `255` (opaque)
-- used for an indicator for a [highlighted word](#highlight_word).
@@ -59,7 +60,7 @@ M.comment_string = {}
-- Used for auto-matching parentheses, brackets, braces, quotes, etc. Keys are
-- lexer language names and values are tables of character match pairs. A pair's
-- key is an ASCII value and the value is the string character match. The
--- defaults are `()`, `[]`, `{}`, `''`, and `""`.
+-- defaults are "()", "[]", "{}", "''", and """".
-- This table can be populated by language-specific modules.
-- @class table
-- @name char_matches
@@ -70,8 +71,8 @@ M.char_matches = { [40] = ')', [91] = ']', [123] = '}', [39] = "'", [34] = '"' }
---
-- Highlighted brace characters.
-- Keys are lexer language names and values are tables of character ASCII values
--- that count as brace characters. The defaults are `(`, `)`, `[`, `]`, `{`, and
--- `}`.
+-- that count as brace characters. The defaults are '(', ')', '[', ']', '{', and
+-- '}'.
-- This table can be populated by language-specific modules.
-- @class table
-- @name braces