diff options
Diffstat (limited to 'core')
| -rw-r--r-- | core/._G.luadoc | 22 | ||||
| -rw-r--r-- | core/.buffer.luadoc | 20 | ||||
| -rw-r--r-- | core/.command_entry.luadoc | 2 | ||||
| -rw-r--r-- | core/.find.luadoc | 16 | ||||
| -rw-r--r-- | core/.gui.luadoc | 17 | ||||
| -rw-r--r-- | core/.view.luadoc | 6 | ||||
| -rw-r--r-- | core/events.lua | 2 | ||||
| -rw-r--r-- | core/keys.lua | 11 |
8 files changed, 46 insertions, 50 deletions
diff --git a/core/._G.luadoc b/core/._G.luadoc index dd205ce8..1cf55e23 100644 --- a/core/._G.luadoc +++ b/core/._G.luadoc @@ -8,18 +8,18 @@ module('_G') -- Markdown: -- ## Fields -- --- * `_HOME`: Path to the directory containing Textadept. --- * `_LEXERPATH`: Paths to lexers, formatted like +-- * `_HOME` [string]: Path to the directory containing Textadept. +-- * `_LEXERPATH` [string]: Paths to lexers, formatted like -- [`package.path`][package_path]. --- * `_RELEASE`: The Textadept release version. --- * `_THEME`: The [theme](../manual/8_Themes.lua) file to use. --- * `_USERHOME`: Path to the user's `~/.textadept/`. --- * `_CHARSET`: The character set encoding of the filesystem. This is used in --- [File I/O](../modules/io.html). --- * `RESETTING`: If [`reset()`](../modules/_G.html#reset) has been called, --- this flag is `true` while the Lua state is being re-initialized. --- * `WIN32`: If Textadept is running on Windows, this flag is `true`. --- * `OSX`: If Textadept is running on Mac OSX, this flag is `true`. +-- * `_RELEASE` [string]: The Textadept release version. +-- * `_THEME` [string]: The [theme](../manual/8_Themes.lua) file to use. +-- * `_USERHOME` [string]: Path to the user's `~/.textadept/`. +-- * `_CHARSET` [string]: The character set encoding of the filesystem. This is +-- used in [File I/O](../modules/io.html). +-- * `RESETTING` [bool]: If [`reset()`](../modules/_G.html#reset) has been +-- called, this flag is `true` while the Lua state is being re-initialized. +-- * `WIN32` [bool]: If Textadept is running on Windows, this flag is `true`. +-- * `OSX` [bool]: If Textadept is running on Mac OSX, this flag is `true`. -- -- [package_path]: http://www.lua.org/manual/5.1/manual.html#pdf-package.path diff --git a/core/.buffer.luadoc b/core/.buffer.luadoc index 532ed8d4..343d501f 100644 --- a/core/.buffer.luadoc +++ b/core/.buffer.luadoc @@ -166,9 +166,9 @@ module('buffer') -- * `_SCINTILLA.constants.EDGE_BACKGROUND` (2): The background color of -- characters after the column limit is changed to the color set by -- `buffer.edge_colour`. --- * `encoding`: The encoding of the file on the hard disk. It will be nil if --- the file is a binary file. --- * `encoding_bom`: The byte-order mark of the file encoding (if any). +-- * `encoding` [string or nil]: The encoding of the file on the hard disk. It +-- will be nil if the file is a binary file. +-- * `encoding_bom` [string]: The byte-order mark of the file encoding (if any). -- * `end_at_last_line` [bool]: Whether the maximum scroll position has the last -- line at the bottom of the view. If `false`, allows scrolling one page below -- the last line. The default value is `true`. @@ -178,16 +178,15 @@ module('buffer') -- extends above the baseline, added to each line. -- * `extra_descent` [number]: The extra descent, the maximum that any style -- extends below the baseline, added to each line. --- * `filename`: The absolute path to the file associated with this buffer. It --- is encoded in UTF-8. Use [`string.iconv()`][string_iconv] for charset --- conversions. +-- * `filename` [string]: The absolute path to the file associated with this +-- buffer. It is encoded in UTF-8. Use [`string.iconv()`][string_iconv] for +-- charset conversions. -- * `first_visible_line` [number]: The display line at the top of the display. -- * `focus` [bool]: The internal focus flag. -- * `fold_expanded` [bool]: Expanded state of a header line. -- * `fold_level` [table]: Table of fold levels for lines starting from zero. -- Fold levels encodes an integer level along witth flags indicating whether --- the line is a header and whether it is effectively white space. --- <br /> +-- the line is a header and whether it is effectively white space.<br /> -- * `_SCINTILLA.constants.SC_FOLDLEVELBASE` (0x400): Initial fold level. -- * `_SCINTILLA.constants.SC_FOLDLEVELWHITEFLAG` (0x1000): Indicates that -- the line is blank. @@ -237,7 +236,7 @@ module('buffer') -- 0 to 31. Used for drawing the outline color of the `INDIC_ROUNDBOX` and -- `INDIC_STRAIGHTBOX` rectangle. -- * `indic_style` [table]: Table of styles for indicators from zero to 31. --- <br /> +-- <br /> -- * `_SCINTILLA.constants.INDIC_PLAIN` (0): Underlined with a single, -- straight line. -- * `_SCINTILLA.constants.INDIC_SQUIGGLE` (1): A squiggly underline. @@ -272,8 +271,7 @@ module('buffer') -- * `indicator_value` [number]: The indicator value used for -- `buffer:indicator_fill_range()`. Currently all values are drawn the same. -- * `keys_unicode` [bool]: Interpret keyboard input as Unicode. --- * `layout_cache` [number]: The degree of caching of layout information. --- <br /> +-- * `layout_cache` [number]: The degree of caching of layout information.<br /> -- * `_SCINTILLA.constants.SC_CACHE_NONE` (0): No lines are cached. -- * `_SCINTILLA.constants.SC_CACHE_CARET` (1): The line containing the -- text caret. This is the default. diff --git a/core/.command_entry.luadoc b/core/.command_entry.luadoc index d26da77a..0eb996c0 100644 --- a/core/.command_entry.luadoc +++ b/core/.command_entry.luadoc @@ -9,7 +9,7 @@ module('gui.command_entry') -- Markdown: -- ## Fields -- --- * `entry_text`: The text in the entry. +-- * `entry_text` [string]: The text in the entry. -- -- ## Events -- diff --git a/core/.find.luadoc b/core/.find.luadoc index 77426400..3b68e7af 100644 --- a/core/.find.luadoc +++ b/core/.find.luadoc @@ -9,16 +9,12 @@ module('gui.find') -- Markdown: -- ## Fields -- --- * `find_entry_text`: The text in the find entry. --- * `replace_entry_text`: The text in the replace entry. --- * `match_case`: Flag indicating whether or not case-sensitive search is --- performed. --- * `whole_word`: Flag indicating whether or not only whole-word matches are --- allowed in searches. --- * `lua`: Flag indicating whether or not the text to find in a search is a Lua --- pattern. --- * `in_files`: Flag indicating whether or not to search for the text in a list --- of files. +-- * `find_entry_text` [string]: The text in the find entry. +-- * `replace_entry_text` [string]: The text in the replace entry. +-- * `match_case` [bool]: Searches are case-sensitive. +-- * `whole_word` [bool]: Only whole-word matches are allowed in searches. +-- * `lua` [bool]: The search text is interpreted as a Lua pattern. +-- * `in_files` [bool]: Search for the text in a list of files. -- -- ## Events -- diff --git a/core/.gui.luadoc b/core/.gui.luadoc index 785ce52b..56e576df 100644 --- a/core/.gui.luadoc +++ b/core/.gui.luadoc @@ -8,15 +8,16 @@ module('gui') -- Markdown: -- ## Fields -- --- * `title`: The title of the Textadept window. --- * `focused_doc_pointer`: The pointer to the document associated with the --- buffer of the currently focused view. (Used internally; read-only.) --- * `menubar`: A table of GTK menus defining a menubar (write-only). +-- * `title` [string]: The title of the Textadept window. +-- * `focused_doc_pointer` [number]: The pointer to the document associated with +-- the buffer of the currently focused view. (Read-only) +-- * `menubar` [table]: A table of GTK menus defining a menubar. (Write-only) -- * `context_menu`: A GTK menu defining the editor's context menu. --- * `clipboard_text`: The text on the clipboard (read-only). --- * `statusbar_text`: The text displayed by the statusbar. --- * `docstatusbar_text`: The text displayed by the doc statusbar (write-only). --- * `size`: The size of the Textadept window (`{ width, height}`). +-- * `clipboard_text` [string]: The text on the clipboard. (Read-only) +-- * `statusbar_text` [string]: The text displayed by the statusbar. +-- * `docstatusbar_text` [string]: The text displayed by the doc statusbar. +-- (Write-only) +-- * `size` [table]: The size of the Textadept window (`{ width, height }`). --- -- Goes to the specified view. diff --git a/core/.view.luadoc b/core/.view.luadoc index 03952327..bf2fe95c 100644 --- a/core/.view.luadoc +++ b/core/.view.luadoc @@ -10,9 +10,9 @@ module('view') -- Markdown: -- ## Fields -- --- * `doc_pointer`: The pointer to the document associated with this view's --- buffer. (Used internally; read-only) --- * `size`: The integer position of the split resizer (if this view is part of +-- * `doc_pointer` [number]: The pointer to the document associated with this +-- view's buffer. (Read-only) +-- * `size` [number]: The position of the split resizer (if this view is part of -- a split view). --- diff --git a/core/events.lua b/core/events.lua index 241aa859..e5a73c8e 100644 --- a/core/events.lua +++ b/core/events.lua @@ -105,7 +105,7 @@ module('events', package.seeall) -- * **hotspot\_release\_click** (position)<br /> -- Called when the user releases the mouse button after clicking on a hotspot. -- - position: the position in the buffer that the user clicked. - +-- -- [buffer_user_list_show]: ../modules/buffer.html#buffer:user_list_show -- -- The following is a list of gui events generated in diff --git a/core/keys.lua b/core/keys.lua index bc26527c..e3170793 100644 --- a/core/keys.lua +++ b/core/keys.lua @@ -51,11 +51,12 @@ module('keys', package.seeall) -- -- ## Settings -- --- * `CTRL`: The string representing the Control key. --- * `SHIFT`: The string representing the Shift key. --- * `ALT`: The string representing the Alt key (the Apple key on Mac OSX). --- * `ADD`: The string representing used to join together a sequence of Control, --- Shift, or Alt modifier keys. +-- * `CTRL` [string]: The string representing the Control key. +-- * `SHIFT` [string]: The string representing the Shift key. +-- * `ALT` [string]: The string representing the Alt key (the Apple key on Mac +-- OSX). +-- * `ADD` [string]: The string representing used to join together a sequence of +-- Control, Shift, or Alt modifier keys. -- -- ## Key Command Precedence -- |