From 9bff1b29293b50e506936e93c14d7a65e8b0ea29 Mon Sep 17 00:00:00 2001 From: mitchell <70453897+667e-11@users.noreply.github.com> Date: Fri, 6 Sep 2013 23:42:13 -0400 Subject: Updated LuaDoc. --- modules/textadept/bookmarks.lua | 7 ++++--- modules/textadept/command_entry.lua | 2 +- modules/textadept/editing.lua | 20 +++++++++++--------- modules/textadept/file_types.lua | 2 +- modules/textadept/find.lua | 8 ++++---- modules/textadept/session.lua | 6 +++--- modules/textadept/snippets.lua | 6 ++++-- 7 files changed, 28 insertions(+), 23 deletions(-) (limited to 'modules') diff --git a/modules/textadept/bookmarks.lua b/modules/textadept/bookmarks.lua index 4e2d7b03..525befa9 100644 --- a/modules/textadept/bookmarks.lua +++ b/modules/textadept/bookmarks.lua @@ -37,9 +37,10 @@ function M.clear() end --- --- Prompts the user to select a bookmarked line to go to unless *next* is given. --- If *next* is `true` or `false`, goes to the next or previous bookmark, --- respectively. +-- Prompts the user to select a bookmarked line to move the caret to the +-- beginning of unless *next* is given. +-- If *next* is `true` or `false`, moves the caret to the beginning of the next +-- or previously bookmarked line, respectively. -- @param next Optional flag indicating whether to go to the next or previous -- bookmarked line relative to the current line. The default value is `nil`, -- prompting the user for a bookmarked line to go to. diff --git a/modules/textadept/command_entry.lua b/modules/textadept/command_entry.lua index 7d9783bb..e5ec6903 100644 --- a/modules/textadept/command_entry.lua +++ b/modules/textadept/command_entry.lua @@ -32,7 +32,7 @@ local M = ui.command_entry -- -- [modes]: keys.html#Modes -- @field entry_text (string) --- The text in the entry. +-- The text in the command entry. module('ui.command_entry')]] --- diff --git a/modules/textadept/editing.lua b/modules/textadept/editing.lua index 36dee287..acd4a5e1 100644 --- a/modules/textadept/editing.lua +++ b/modules/textadept/editing.lua @@ -6,8 +6,8 @@ local M = {} --- -- Editing features for Textadept. -- @field AUTOPAIR (bool) --- Automatically close opening '(', '[', '{', '"', or ''' --- characters. +-- 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. @@ -16,8 +16,8 @@ local M = {} -- The default value is `true`. -- Matching braces are defined in the [`braces`](#braces) table. -- @field TYPEOVER_CHARS (bool) --- Move over the typeover character under the caret when typing it instead of --- inserting it. +-- Move over closing brace and quote characters under the caret when typing +-- them instead of inserting them. -- The default value is `true`. -- Typeover characters are defined in the [`typeover_chars`](#typeover_chars) -- table. @@ -43,7 +43,7 @@ M.HIGHLIGHT_COLOR = not CURSES and 'color.orange' or 'color.yellow' -- Map of lexer names to line comment strings for programming languages, used by -- the `block_comment()` function. -- Keys are lexer names and values are either the language's line comment --- prefixes or block comment delimiters separated by a '|'. +-- prefixes or block comment delimiters separated by a '|' character. -- @class table -- @name comment_string -- @see block_comment @@ -261,13 +261,15 @@ function M.autocomplete_word(default_words) end --- --- Comments or uncomments the selected lines with line comment string *comment* --- or the comment from the `comment_string` table for the current lexer. +-- Comments or uncomments the selected lines with line comment or block comment +-- delimiters string *comment* or the comment from the `comment_string` table +-- for the current lexer. +-- Block comment delimiters are separated by a '|' character. -- As long as any part of a line is selected, the entire line is eligible for -- commenting/uncommenting. -- @param comment Optional comment string inserted or removed from each line in --- the selection. Comment delimiters are separated by a '|'. The default value --- is the comment in the `comment_string` table for the current lexer. +-- the selection. The default value is the comment in the `comment_string` +-- table for the current lexer. -- @see comment_string -- @name block_comment function M.block_comment(comment) diff --git a/modules/textadept/file_types.lua b/modules/textadept/file_types.lua index c34ab0e3..e99374a0 100644 --- a/modules/textadept/file_types.lua +++ b/modules/textadept/file_types.lua @@ -11,7 +11,7 @@ local M = {} -- properties since the module is not loaded when Textadept starts. -- Arguments: -- --- * *`lang`*: The language lexer name. +-- * *`lexer`*: The language lexer name. module('textadept.file_types')]] -- Events. diff --git a/modules/textadept/find.lua b/modules/textadept/find.lua index f83c626c..43a48223 100644 --- a/modules/textadept/find.lua +++ b/modules/textadept/find.lua @@ -78,8 +78,8 @@ events.FIND_WRAPPED = 'find_wrapped' local preferred_view --- --- Table of Lua patterns matching files and folders to exclude when finding in --- files. +-- The table of Lua patterns matching files and folders to exclude when finding +-- in files. -- Each filter string is a pattern that matches filenames to exclude, with -- patterns matching folders to exclude listed in a `folders` sub-table. -- Patterns starting with '!' exclude files and folders that do not match the @@ -208,8 +208,8 @@ function M.find_incremental(text, next, anchor) end --- --- Searches the *utf8_dir* or user-specified directory for files that match --- search text and options and prints the results to a buffer. +-- Searches directory *utf8_dir* or user-specified directory for files that +-- match search text and options and prints the results to a files found buffer. -- Use the `find_text`, `match_case`, `whole_word`, and `lua` fields to set the -- search text and option flags, respectively. Use `FILTER` to set the search -- filter. diff --git a/modules/textadept/session.lua b/modules/textadept/session.lua index f31a944e..8ae408fd 100644 --- a/modules/textadept/session.lua +++ b/modules/textadept/session.lua @@ -17,7 +17,7 @@ local M = {} -- The default value is `true`, but is disabled when passing the command line -- switch `-n` or `--nosession` to Textadept. -- @field MAX_RECENT_FILES (number) --- The maximum number of recent files to save to the session. +-- The maximum number of recent files to save to session files. -- Recent files are stored in [`io.recent_files`][]. -- The default value is `10`. -- @@ -29,8 +29,8 @@ M.SAVE_ON_QUIT = true M.MAX_RECENT_FILES = 10 --- --- Loads the Textadept session file *filename* or prompts the user to select --- one, returning `true` if the session file was opened and read. +-- Loads Textadept session file *filename* or prompts the user to selectone, +-- returning `true` if the session file was opened and read. -- Textadept restores split views, opened buffers, cursor information, and -- recent files. -- @param filename Optional absolute path to the session file to load. If `nil`, diff --git a/modules/textadept/snippets.lua b/modules/textadept/snippets.lua index 4827c8c8..9b8e8bda 100644 --- a/modules/textadept/snippets.lua +++ b/modules/textadept/snippets.lua @@ -67,11 +67,13 @@ local M = {} -- -- ### `\t` -- --- A single unit of indentation based on the user's indentation settings. +-- A single unit of indentation based on the user's indentation settings +-- (`buffer.use_tabs` and `buffer.tab_width`). -- -- ### `\n` -- --- A single set of line ending delimiters based on the user's end of line mode. +-- A single set of line ending delimiters based on the user's end of line mode +-- (`buffer.eol_mode`). -- -- [`io.popen()`]: http://www.lua.org/manual/5.2/manual.html#pdf-io.popen module('textadept.snippets')]=] -- cgit v1.2.3