aboutsummaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
Diffstat (limited to 'modules')
-rw-r--r--modules/ansi_c/init.lua1
-rw-r--r--modules/lua/init.lua3
-rw-r--r--modules/textadept/command_entry.lua12
-rw-r--r--modules/textadept/editing.lua8
-rw-r--r--modules/textadept/find.lua1
-rw-r--r--modules/textadept/keys.lua4
-rw-r--r--modules/textadept/menu.lua7
-rw-r--r--modules/textadept/run.lua6
-rw-r--r--modules/textadept/session.lua12
-rw-r--r--modules/textadept/snippets.lua8
10 files changed, 26 insertions, 36 deletions
diff --git a/modules/ansi_c/init.lua b/modules/ansi_c/init.lua
index 3f6daf1d..d96aa0e7 100644
--- a/modules/ansi_c/init.lua
+++ b/modules/ansi_c/init.lua
@@ -21,7 +21,6 @@ module('_M.ansi_c')]]
-- List of ctags files to use for autocompletion.
-- @class table
-- @name tags
--- @see textadept.editing.autocomplete
M.tags = {_HOME..'/modules/ansi_c/tags', _USERHOME..'/modules/ansi_c/tags'}
local XPM = textadept.editing.XPM_IMAGES
diff --git a/modules/lua/init.lua b/modules/lua/init.lua
index f1b5d834..0351cc89 100644
--- a/modules/lua/init.lua
+++ b/modules/lua/init.lua
@@ -24,7 +24,6 @@ module('_M.lua')]]
-- 'F' as a module or table field.
-- @class table
-- @name tags
--- @see textadept.editing.autocomplete
M.tags = {_HOME..'/modules/lua/tags', _USERHOME..'/modules/lua/tags'}
---
@@ -96,8 +95,8 @@ local control_structure_patterns = {
---
-- Tries to autocomplete control structures like `if`, `while`, `for`, etc. with
-- the `end` keyword.
--- @see control_structure_patterns
-- @name try_to_autocomplete_end
+-- @see control_structure_patterns
function M.try_to_autocomplete_end()
local line_num = buffer:line_from_position(buffer.current_pos)
local line = buffer:get_line(line_num)
diff --git a/modules/textadept/command_entry.lua b/modules/textadept/command_entry.lua
index 6d495199..b75405ca 100644
--- a/modules/textadept/command_entry.lua
+++ b/modules/textadept/command_entry.lua
@@ -9,11 +9,11 @@ local M = ui.command_entry
--
-- ## Modes
--
--- The command entry supports multiple [modes][] that have their own sets of key
--- bindings stored in a separate table in `_G.keys` under a mode prefix key.
--- Mode names are arbitrary, but cannot conflict with lexer names or key
--- sequence strings (e.g. `'lua'` or `'send'`) due to the method Textadept uses
--- for looking up key bindings. An example mode is "lua_command" mode for
+-- The command entry supports multiple [modes](#keys.Modes) that have their own
+-- sets of key bindings stored in a separate table in `_G.keys` under a mode
+-- prefix key. Mode names are arbitrary, but cannot conflict with lexer names or
+-- key sequence strings (e.g. `'lua'` or `'send'`) due to the method Textadept
+-- uses for looking up key bindings. An example mode is "lua_command" mode for
-- executing Lua commands:
--
-- local function complete_lua() ... end
@@ -30,8 +30,6 @@ local M = ui.command_entry
-- `Tab` shows a list of Lua completions for the entry text and `Enter` exits
-- "lua_command" key mode and executes the entered code. The command entry
-- handles all other keys normally.
---
--- [modes]: keys.html#Modes
-- @field entry_text (string)
-- The text in the command entry.
module('ui.command_entry')]]
diff --git a/modules/textadept/editing.lua b/modules/textadept/editing.lua
index 31bbbaa5..ce93dd54 100644
--- a/modules/textadept/editing.lua
+++ b/modules/textadept/editing.lua
@@ -9,14 +9,14 @@ local M = {}
-- Automatically close opening brace and quote characters with their
-- complements.
-- The default value is `true`.
--- Auto-paired characters are defined in the [`char_matches`](#char_matches)
--- table.
+-- Auto-paired characters are defined in the
+-- [`textadept.editing.char_matches`]() table.
-- @field TYPEOVER_CHARS (bool)
-- Move over closing brace and quote characters under the caret when typing
-- them.
-- The default value is `true`.
--- Typeover characters are defined in the [`typeover_chars`](#typeover_chars)
--- table.
+-- Typeover characters are defined in the
+-- [`textadept.editing.typeover_chars`]() table.
-- @field AUTOINDENT (bool)
-- Match the previous line's indentation level after inserting a new line.
-- The default value is `true`.
diff --git a/modules/textadept/find.lua b/modules/textadept/find.lua
index e293a7c4..405f1c44 100644
--- a/modules/textadept/find.lua
+++ b/modules/textadept/find.lua
@@ -89,6 +89,7 @@ local preferred_view
-- The default value is `lfs.FILTER`, a filter for common binary file extensions
-- and version control directories.
-- @see find_in_files
+-- @see lfs.FILTER
-- @class table
-- @name FILTER
M.FILTER = lfs.FILTER
diff --git a/modules/textadept/keys.lua b/modules/textadept/keys.lua
index 9d16921e..ba2aac5e 100644
--- a/modules/textadept/keys.lua
+++ b/modules/textadept/keys.lua
@@ -572,8 +572,8 @@ keys[not OSX and not CURSES and 'c0' or 'm0'] = utils.reset_zoom
-- Help.
if not CURSES then
- keys.f1 = {utils.open_webpage, _HOME..'/doc/01_Introduction.html'}
- keys.sf1 = {utils.open_webpage, _HOME..'/doc/api/index.html'}
+ keys.f1 = {utils.open_webpage, _HOME..'/doc/manual.html'}
+ keys.sf1 = {utils.open_webpage, _HOME..'/doc/api.html'}
end
-- Movement commands.
diff --git a/modules/textadept/menu.lua b/modules/textadept/menu.lua
index a3da4092..2c35dc4d 100644
--- a/modules/textadept/menu.lua
+++ b/modules/textadept/menu.lua
@@ -10,7 +10,7 @@ local M = {}
-- keys with string text. Use the '#' operator (instead of `ipairs()`) for
-- iteration.
-- If applicable, load this module last in your *~/.textadept/init.lua*, after
--- `textadept.keys` since it looks up defined key commands to show them in
+-- [`textadept.keys`]() since it looks up defined key commands to show them in
-- menus.
module('textadept.menu')]]
@@ -194,9 +194,8 @@ local menubar = {
{_L['_Reset Zoom'], utils.reset_zoom},
},
{ title = _L['_Help'],
- {_L['Show _Manual'],
- {utils.open_webpage, _HOME..'/doc/manual/01_Introduction.html'}},
- {_L['Show _LuaDoc'], {utils.open_webpage, _HOME..'/doc/api/index.html'}},
+ {_L['Show _Manual'], {utils.open_webpage, _HOME..'/doc/manual.html'}},
+ {_L['Show _LuaDoc'], {utils.open_webpage, _HOME..'/doc/api.html'}},
SEPARATOR,
{_L['_About'],
{ui.dialogs.msgbox, {title = 'Textadept', text = _RELEASE,
diff --git a/modules/textadept/run.lua b/modules/textadept/run.lua
index 5c83a37d..7c1c62b3 100644
--- a/modules/textadept/run.lua
+++ b/modules/textadept/run.lua
@@ -5,10 +5,8 @@ local M = {}
--[[ This comment is for LuaDoc.
---
-- Compile and run source code files with Textadept.
--- [Language modules][] may tweak the `compile_commands`, `run_commands`, and/or
--- `error_patterns` tables for particular languages.
---
--- [Language modules]: _M.html#Compile.and.Run
+-- [Language modules](#_M.Compile.and.Run) may tweak the `compile_commands`,
+-- `run_commands`, and/or `error_patterns` tables for particular languages.
-- @field MARK_WARNING (number)
-- The run or compile warning marker number.
-- @field MARK_ERROR (number)
diff --git a/modules/textadept/session.lua b/modules/textadept/session.lua
index fd5a595d..5b5c9840 100644
--- a/modules/textadept/session.lua
+++ b/modules/textadept/session.lua
@@ -7,21 +7,17 @@ local M = {}
-- Session support for Textadept.
-- @field DEFAULT_SESSION (string)
-- The path to the default session file, *`_USERHOME`/session*, or
--- *`_USERHOME`/session_term* if [`_G.CURSES`][] is `true`.
---
--- [`_G.CURSES`]: _G.html#CURSES
+-- *`_USERHOME`/session_term* if [`CURSES`]() is `true`.
-- @field SAVE_ON_QUIT (bool)
-- Save the session when quitting.
--- The session file saved is always `DEFAULT_SESSION`, even if a different
--- session was loaded with [`load()`](#load).
+-- The session file saved is always `textadept.session.DEFAULT_SESSION`, even
+-- if a different session was loaded with [`textadept.session.load()`]().
-- The default value is `true` unless the user passed the command line switch
-- `-n` or `--nosession` to Textadept.
-- @field MAX_RECENT_FILES (number)
-- The maximum number of recent files to save in session files.
--- Recent files are stored in [`io.recent_files`][].
+-- Recent files are stored in [`io.recent_files`]().
-- The default value is `10`.
---
--- [`io.recent_files`]: io.html#recent_files
module('textadept.session')]]
M.DEFAULT_SESSION = _USERHOME..(not CURSES and '/session' or '/session_term')
diff --git a/modules/textadept/snippets.lua b/modules/textadept/snippets.lua
index e373e6aa..6fa03c06 100644
--- a/modules/textadept/snippets.lua
+++ b/modules/textadept/snippets.lua
@@ -23,8 +23,8 @@ local M = {}
--
-- Represents a placeholder, where *n* is an integer and *text* is default
-- placeholder text. Textadept moves the caret to placeholders in numeric order
--- each time it calls [`_insert()`](#_insert), finishing at either the "%0"
--- placeholder if it exists or at the end of the snippet. Examples are
+-- each time it calls [`textadept.snippets._insert()`](), finishing at either
+-- the "%0" placeholder if it exists or at the end of the snippet. Examples are
--
-- snippets['foo'] = 'foobar%1(baz)'
-- snippets['bar'] = 'start\n\t%0\nend'
@@ -65,12 +65,12 @@ local M = {}
-- ### `\t`
--
-- A single unit of indentation based on the user's indentation settings
--- (`buffer.use_tabs` and `buffer.tab_width`).
+-- ([`buffer.use_tabs`]() and [`buffer.tab_width`]()).
--
-- ### `\n`
--
-- A single set of line ending delimiters based on the user's end of line mode
--- (`buffer.eol_mode`).
+-- ([`buffer.eol_mode`]()).
--
-- [`io.popen()`]: http://www.lua.org/manual/5.2/manual.html#pdf-io.popen
module('textadept.snippets')]=]
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-09 05:55:24 +0000