aboutsummaryrefslogtreecommitdiff
path: root/modules/textadept
diff options
context:
space:
mode:
Diffstat (limited to 'modules/textadept')
-rw-r--r--modules/textadept/adeptsense.lua26
-rw-r--r--modules/textadept/bookmarks.lua2
-rw-r--r--modules/textadept/editing.lua15
-rw-r--r--modules/textadept/keys.lua14
-rw-r--r--modules/textadept/mime_types.lua8
-rw-r--r--modules/textadept/session.lua4
-rw-r--r--modules/textadept/snapopen.lua2
-rw-r--r--modules/textadept/snippets.lua10
8 files changed, 41 insertions, 40 deletions
diff --git a/modules/textadept/adeptsense.lua b/modules/textadept/adeptsense.lua
index 245dc23f..0f8f15a3 100644
--- a/modules/textadept/adeptsense.lua
+++ b/modules/textadept/adeptsense.lua
@@ -82,7 +82,7 @@ local M = {}
-- #### `symbol_chars`
--
-- In addition to the usual `[%w_%.]` symbol characters, Lua also allows symbols
--- to contain a `:`.
+-- to contain a ':'.
--
-- sense.syntax.symbol_chars = '[%w_%.:]'
--
@@ -109,7 +109,7 @@ local M = {}
-- ['^([%w_%.]+)'] = '%1' -- foo = _M.textadept.adeptsense
-- }
--
--- Note the `^` in the pattern. The beginning of the right hand side of the
+-- Note the '^' in the pattern. The beginning of the right hand side of the
-- assignment should be matched, otherwise `local foo = bar('baz')` could infer
-- an incorrect type.
--
@@ -139,7 +139,7 @@ local M = {}
-- in your shell. Since Adeptsense only cares about classes, functions, and
-- fields, you need to let it know which kind of tag is which. Unfortunately,
-- Lua support in Ctags is not good at all. Instead, Textadept has a utility
--- (`modules/lua/adeptsensedoc.lua`) to generate a fake set of tags that is more
+-- (*modules/lua/adeptsensedoc.lua*) to generate a fake set of tags that is more
-- useful. Functions are tagged `'f'` and should be recognized as such; table
-- keys are tagged `'t'` and should be recognized as fields; module fields,
-- `'F'`, should be fields; and modules, `'m'`, should be classes:
@@ -170,8 +170,8 @@ local M = {}
-- ### Triggers
--
-- Triggers are characters or character sequences that trigger an autocompletion
--- list to be displayed. Lua has two characters that can do so: `.` and `:`. The
--- `.` should autocomplete both fields and functions while `:` should
+-- list to be displayed. Lua has two characters that can do so: '.' and ':'. The
+-- '.' should autocomplete both fields and functions while ':' should
-- autocomplete only functions. This is specified using
-- [`add_trigger()`](#add_trigger).
--
@@ -235,7 +235,7 @@ local M = {}
-- end
--
-- Note that there is no plus or minus prefix in the pattern. This is because
--- `+` or `-` characters are not a part of `syntax.symbol_chars` so a symbol
+-- '+' or '-' characters are not a part of `syntax.symbol_chars` so a symbol
-- will not contain either of them.
--
-- Like numbers, the syntax for constructing strings, arrays, hashes, and the
@@ -260,7 +260,7 @@ local M = {}
--
-- Since Adeptsense ignores any tags not mapped to `classes`, `functions`, or
-- `fields` in [`ctags_kinds`](#ctags_kinds), it passes an unknown tag to the
--- [`handle_ctag()`](#handle_ctag) function. In this case, package (`p`) tags
+-- [`handle_ctag()`](#handle_ctag) function. In this case, package ('p') tags
-- need to be handled.
--
-- function sense:handle_ctag(tag_name, file_name, ex_cmd, ext_fields)
@@ -275,7 +275,7 @@ local M = {}
-- end
--
-- Now that we have a list of import completions, it should be activated by the
--- normal trigger (`.`), but only on a line that contains an `import` statement.
+-- normal trigger ('.'), but only on a line that contains an `import` statement.
-- The [`get_completions`](#get_completions) function needs to be overridden to
-- use the `import` table's completions when necessary.
--
@@ -319,7 +319,7 @@ local M = {}
-- Adeptsense. For example, when editing CSS inside of an HTML file, the user
-- expects the CSS Adeptsense to be used. However, child language Adeptsenses
-- are not loaded automatically and must be loaded by the parent language
--- module. For the case of CSS in HTML, the HTML module's `init.lua` must
+-- module. For the case of CSS in HTML, the HTML module's *init.lua* must
-- contain:
--
-- -- Load CSS Adeptsense.
@@ -331,11 +331,11 @@ local M = {}
-- ### Generating Lua Adeptsense
--
-- You can generate Lua Adeptsense for your own modules using the Lua language
--- module's `adeptsensedoc.lua` module with [LuaDoc][]:
+-- module's *adeptsensedoc.lua* module with [LuaDoc][]:
--
-- luadoc -d . --doclet _HOME/modules/lua/adeptsensedoc [module(s)]
--
--- where `_HOME` is where Textadept is installed. The `tags` and `api` files are
+-- where `_HOME` is where Textadept is installed. The *tags* and *api* files are
-- output to the current directory and can be loaded via
-- [`load_ctags()`](#load_ctags) and [`api_files`](#api_files) respectively.
--
@@ -930,8 +930,8 @@ locations = {},
-- there may be many duplicate symbol names, it is recommended to put the full
-- symbol and arguments, if any, on the first line. (e.g. `Class.function(arg1,
-- arg2, ...)`). This allows the correct documentation to be shown based on the
--- current context. In the documentation, newlines are represented with `\n`. A
--- `\` before `\n` escapes the newline.
+-- current context. In the documentation, newlines are represented with "\n". A
+-- '\' before "\n" escapes the newline.
-- @class table
-- @name api_files
api_files = {},
diff --git a/modules/textadept/bookmarks.lua b/modules/textadept/bookmarks.lua
index 1812f2d6..1b568357 100644
--- a/modules/textadept/bookmarks.lua
+++ b/modules/textadept/bookmarks.lua
@@ -6,7 +6,7 @@ local M = {}
---
-- Bookmarks for Textadept.
-- @field MARK_BOOKMARK_COLOR (number)
--- The color used for a bookmarked line in `0xBBGGRR` format.
+-- The color used for a bookmarked line in "0xBBGGRR" format.
module('_M.textadept.bookmarks')]]
M.MARK_BOOKMARK_COLOR = not NCURSES and 0xB3661A or 0xFF0000
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 '(', '[', '{', '"', or ''' 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
diff --git a/modules/textadept/keys.lua b/modules/textadept/keys.lua
index 9166b867..0a74b7c4 100644
--- a/modules/textadept/keys.lua
+++ b/modules/textadept/keys.lua
@@ -107,13 +107,13 @@ local M = {}
-- None |None |None |Tab width: 8
-- Ctrl+Alt+Shift+T|^⇧T |M-T<br/>M-S-T|Toggle use tabs
-- Ctrl+Alt+I |^I |M-I |Convert indentation
--- None |None |None |`CRLF` EOL mode
--- None |None |None |`CR` EOL mode
--- None |None |None |`LF` EOL mode
--- None |None |None |`UTF-8` encoding
--- None |None |None |`ASCII` encoding
--- None |None |None |`ISO-8859-1` encoding
--- None |None |None |`UTF-16` encoding
+-- None |None |None |CR+LF EOL mode
+-- None |None |None |CR EOL mode
+-- None |None |None |LF EOL mode
+-- None |None |None |UTF-8 encoding
+-- None |None |None |ASCII encoding
+-- None |None |None |ISO-8859-1 encoding
+-- None |None |None |UTF-16 encoding
-- Ctrl+Shift+L |⌘⇧L |M-S-L |Select lexer...
-- F5 |F5 |^L<br/>F5 |Refresh syntax highlighting
-- **View** | | |
diff --git a/modules/textadept/mime_types.lua b/modules/textadept/mime_types.lua
index 7c71fa7f..2675b9fc 100644
--- a/modules/textadept/mime_types.lua
+++ b/modules/textadept/mime_types.lua
@@ -28,7 +28,7 @@ M.extensions = {}
---
-- Table of shebang words and their associated lexers.
--- If the file has a shebang line, a line that starts with `#!` and is the first
+-- If the file has a shebang line, a line that starts with "#!" and is the first
-- line in the file, each shebang word is matched against that line.
-- @class table
-- @name shebangs
@@ -42,7 +42,7 @@ M.shebangs = {}
-- @name patterns
M.patterns = {}
--- Load mime-types from `modules/textadept/mime_types.conf`.
+-- Load mime-types from *modules/textadept/mime_types.conf*.
local mime_types
local f = io.open(_HOME..'/modules/textadept/mime_types.conf', 'rb')
if f then
@@ -70,7 +70,7 @@ end
---
-- List of detected lexers.
--- Lexers are read from `lexers/` and `~/.textadept/lexers/`.
+-- Lexers are read from *lexers/* and *~/.textadept/lexers/*.
-- @class table
-- @name lexers
M.lexers = {}
@@ -111,7 +111,7 @@ end
-- Contains the whitespace styles for lexers.
-- These whitespace styles are used to determine the lexer at the current caret
--- position since the styles have the name `[lang]_whitespace`.
+-- position since the styles have the name "[lang]_whitespace".
-- @class table
-- @name ws_styles
local ws_styles = {}
diff --git a/modules/textadept/session.lua b/modules/textadept/session.lua
index 24554e35..49c49568 100644
--- a/modules/textadept/session.lua
+++ b/modules/textadept/session.lua
@@ -7,8 +7,8 @@ local M = {}
-- Session support for Textadept.
-- @field DEFAULT_SESSION (string)
-- The path to the default session file.
--- The default value is `_USERHOME/session`, or `_USERHOME/session_term` if
--- [`_G.NCURSES`][] is `true`.
+-- The default value is *`_USERHOME`/session*, or *`_USERHOME`/session_term*
+-- if [`_G.NCURSES`][] is `true`.
--
-- [`_G.NCURSES`]: _G.html#NCURSES
-- @field SAVE_ON_QUIT (bool)
diff --git a/modules/textadept/snapopen.lua b/modules/textadept/snapopen.lua
index c677ba66..268ee3b2 100644
--- a/modules/textadept/snapopen.lua
+++ b/modules/textadept/snapopen.lua
@@ -87,7 +87,7 @@ end
-- paths to search.
-- @param filter A filter for files and folders to exclude. The filter may be
-- a string or table. Each filter is a Lua pattern. Any files matching a
--- filter are excluded. Prefix a pattern with `!` to exclude any files that
+-- filter are excluded. Prefix a pattern with '!' to exclude any files that
-- do not match a filter. File extensions can be more efficiently excluded by
-- adding the extension text to a table assigned to an `extensions` key in the
-- filter table instead of using individual filters. Directories can be
diff --git a/modules/textadept/snippets.lua b/modules/textadept/snippets.lua
index 6dd9fdb2..c179a580 100644
--- a/modules/textadept/snippets.lua
+++ b/modules/textadept/snippets.lua
@@ -10,7 +10,7 @@ local M = {}
--
-- Snippets are defined in the global table `snippets`. Each key-value pair in
-- `snippets` consists of either a string trigger word and its snippet text, or
--- a string lexer language (from the `lexers/` directory) with a table of
+-- a string lexer language (from the *lexers/* directory) with a table of
-- trigger words and snippet texts. When searching for a snippet to insert based
-- on a trigger word, snippets in the current lexer have priority, followed by
-- the ones in the global table. This means if there are two snippets with the
@@ -19,9 +19,9 @@ local M = {}
--
-- ## Snippet Syntax
--
--- Any plain text characters may be used with the exception of `%`. Just like in
--- Lua patterns, `%` is an escape character. The sequence `%%` stands for a
--- single `%`. Also, it is recommended to use `\t` characters for indentation
+-- Any plain text characters may be used with the exception of '%'. Just like in
+-- Lua patterns, '%' is an escape character. The sequence "%%" stands for a
+-- single '%'. Also, it is recommended to use "\t" characters for indentation
-- because they can be converted to spaces based on the current indentation
-- settings. In addition to plain text, snippets can contain placeholders for
-- further user input, can mirror or transform those user inputs, and/or execute
@@ -360,7 +360,7 @@ M._snippet_mt = {
snippet_stack[#snippet_stack] = nil
end,
- -- Finishes a snippet by going to its `%0` placeholder and cleaning up.
+ -- Finishes a snippet by going to its "%0" placeholder and cleaning up.
-- @param snippet The snippet returned by `new_snippet()`.
finish = function(snippet)
local buffer = buffer
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-09 07:42:55 +0000