diff options
Diffstat (limited to 'core')
| -rw-r--r-- | core/.buffer.luadoc | 1 | ||||
| -rw-r--r-- | core/.ui.dialogs.luadoc | 22 | ||||
| -rw-r--r-- | core/args.lua | 3 | ||||
| -rw-r--r-- | core/events.lua | 9 | ||||
| -rw-r--r-- | core/file_io.lua | 4 | ||||
| -rw-r--r-- | core/init.lua | 8 |
6 files changed, 22 insertions, 25 deletions
diff --git a/core/.buffer.luadoc b/core/.buffer.luadoc index d36c1dc0..8060a41d 100644 --- a/core/.buffer.luadoc +++ b/core/.buffer.luadoc @@ -2821,6 +2821,7 @@ function upper_case(buffer) end -- @param items The sorted string of words to show, separated by -- `buffer.auto_c_separator` characters (initially spaces). -- @see _SCINTILLA.next_user_list_type +-- @see events.USER_LIST_SELECTION function user_list_show(buffer, id, items) end --- diff --git a/core/.ui.dialogs.luadoc b/core/.ui.dialogs.luadoc index fed8b340..0a18e6e1 100644 --- a/core/.ui.dialogs.luadoc +++ b/core/.ui.dialogs.luadoc @@ -67,7 +67,7 @@ function msgbox(options) end -- * `height`: The dialog's pixel height. -- * `float`: Show the dialog on top of all desktop windows. The default value -- is `false`. --- * `timeout`: the integer number of seconds the dialog waits for the user to +-- * `timeout`: The integer number of seconds the dialog waits for the user to -- select a button before timing out. Dialogs do not time out by default. -- @return selected button or exit code function ok_msgbox(options) end @@ -98,7 +98,7 @@ function ok_msgbox(options) end -- * `height`: The dialog's pixel height. -- * `float`: Show the dialog on top of all desktop windows. The default value -- is `false`. --- * `timeout`: the integer number of seconds the dialog waits for the user to +-- * `timeout`: The integer number of seconds the dialog waits for the user to -- select a button before timing out. Dialogs do not time out by default. -- @return selected button or exit code function yesno_msgbox(options) end @@ -134,7 +134,7 @@ function yesno_msgbox(options) end -- * `height`: The dialog's pixel height. -- * `float`: Show the dialog on top of all desktop windows. The default value -- is `false`. --- * `timeout`: the integer number of seconds the dialog waits for the user to +-- * `timeout`: The integer number of seconds the dialog waits for the user to -- select a button before timing out. Dialogs do not time out by default. -- @return selected button or exit code, input text -- @usage ui.dialogs.inputbox{title = 'Goto Line', informative_text = 'Line:', @@ -169,7 +169,7 @@ function inputbox(options) end -- * `height`: The dialog's pixel height. -- * `float`: Show the dialog on top of all desktop windows. The default value -- is `false`. --- * `timeout`: the integer number of seconds the dialog waits for the user to +-- * `timeout`: The integer number of seconds the dialog waits for the user to -- select a button before timing out. Dialogs do not time out by default. -- @return selected button or exit code, input text function standard_inputbox(options) end @@ -205,7 +205,7 @@ function standard_inputbox(options) end -- * `height`: The dialog's pixel height. -- * `float`: Show the dialog on top of all desktop windows. The default value -- is `false`. --- * `timeout`: the integer number of seconds the dialog waits for the user to +-- * `timeout`: The integer number of seconds the dialog waits for the user to -- select a button before timing out. Dialogs do not time out by default. -- @return selected button or exit code, input text function secure_inputbox(options) end @@ -238,7 +238,7 @@ function secure_inputbox(options) end -- * `height`: The dialog's pixel height. -- * `float`: Show the dialog on top of all desktop windows. The default value -- is `false`. --- * `timeout`: the integer number of seconds the dialog waits for the user to +-- * `timeout`: The integer number of seconds the dialog waits for the user to -- select a button before timing out. Dialogs do not time out by default. -- @return selected button or exit code, input text function secure_standard_inputbox(options) end @@ -317,7 +317,7 @@ function filesave(options) end -- * `height`: The dialog's pixel height. -- * `float`: Show the dialog on top of all desktop windows. The default value -- is `false`. --- * `timeout`: the integer number of seconds the dialog waits for the user to +-- * `timeout`: The integer number of seconds the dialog waits for the user to -- select a button before timing out. Dialogs do not time out by default. -- @return selected button or exit code, textbox text -- @usage ui.dialogs.textbox{title = 'License Agreement', @@ -356,7 +356,7 @@ function textbox(options) end -- * `height`: The dialog's pixel height. -- * `float`: Show the dialog on top of all desktop windows. The default value -- is `false`. --- * `timeout`: the integer number of seconds the dialog waits for the user to +-- * `timeout`: The integer number of seconds the dialog waits for the user to -- select a button before timing out. Dialogs do not time out by default. -- @return selected button or exit code, selected item -- @usage ui.dialogs.dropdown{title = 'Select Encoding', width = 200, @@ -392,7 +392,7 @@ function dropdown(options) end -- * `height`: The dialog's pixel height. -- * `float`: Show the dialog on top of all desktop windows. The default value -- is `false`. --- * `timeout`: the integer number of seconds the dialog waits for the user to +-- * `timeout`: The integer number of seconds the dialog waits for the user to -- select a button before timing out. Dialogs do not time out by default. -- @return selected button or exit code, selected item function standard_dropdown(options) end @@ -435,7 +435,7 @@ function standard_dropdown(options) end -- * `height`: The dialog's pixel height. -- * `float`: Show the dialog on top of all desktop windows. The default value -- is `false`. --- * `timeout`: the integer number of seconds the dialog waits for the user to +-- * `timeout`: The integer number of seconds the dialog waits for the user to -- select a button before timing out. Dialogs do not time out by default. -- @return selected button or exit code, selected item or list of selected items -- @usage ui.dialogs.filteredlist{title = 'Title', columns = {'Foo', 'Bar'}, @@ -469,7 +469,7 @@ function filteredlist(options) end -- * `height`: The dialog's pixel height. -- * `float`: Show the dialog on top of all desktop windows. The default value -- is `false`. --- * `timeout`: the integer number of seconds the dialog waits for the user to +-- * `timeout`: The integer number of seconds the dialog waits for the user to -- select a button before timing out. Dialogs do not time out by default. -- @return selected button or exit code, list of selected options -- @usage ui.dialogs.optionselect{title = 'Language', diff --git a/core/args.lua b/core/args.lua index 834ba973..cb6454b5 100644 --- a/core/args.lua +++ b/core/args.lua @@ -5,9 +5,6 @@ local M = {} --[[ This comment is for LuaDoc. --- -- Processes command line arguments for Textadept. --- --- ## Arg Events --- -- @field _G.events.ARG_NONE (string) -- Emitted when no command line arguments are passed to Textadept on startup. module('args')]] diff --git a/core/events.lua b/core/events.lua index 2173ea4b..0569b09a 100644 --- a/core/events.lua +++ b/core/events.lua @@ -6,8 +6,6 @@ local M = {} --- -- Textadept's core event structure and handlers. -- --- ## Overview --- -- Textadept emits events when you do things like create a new buffer, press a -- key, click on a menu, etc. You can even emit events yourself using Lua. Each -- event has a set of event handlers, which are simply Lua functions called in @@ -119,7 +117,7 @@ local M = {} -- -- * _`text`_: The error message text. -- @field FIND (string) --- Emitted to find text via the Find & Replace Pane. +-- Emitted in order to find text via the Find & Replace Pane. -- Arguments: -- -- * _`text`_: The text to search for. @@ -170,7 +168,8 @@ local M = {} -- Emitted after selecting a menu item. -- Arguments: -- --- * _`menu_id`_: The numeric ID of the menu item set in [`ui.menu()`](). +-- * _`menu_id`_: The numeric ID of the menu item, which was defined in +-- [`ui.menu()`](). -- @field MOUSE (string) -- Emitted by the terminal version for an unhandled mouse event. -- Arguments: @@ -192,7 +191,7 @@ local M = {} -- procedure. -- Emitted by [`quit()`](). -- @field REPLACE (string) --- Emitted to replace selected (found) text. +-- Emitted in order to replace selected (found) text. -- Arguments: -- -- * _`text`_: The replacement text. diff --git a/core/file_io.lua b/core/file_io.lua index 62966f3a..c4aecfe3 100644 --- a/core/file_io.lua +++ b/core/file_io.lua @@ -25,8 +25,8 @@ -- filename. -- @field _G.events.FILE_CHANGED (string) -- Emitted when Textadept detects that an open file was modified externally. --- When connecting to this event, connect with an index of 1 to override the --- default prompt to reload the file. +-- When connecting to this event, connect with an index of 1 in order to +-- override the default prompt to reload the file. -- Arguments: -- -- * _`filename`_: The filename externally modified. diff --git a/core/init.lua b/core/init.lua index 3b9f35cf..779dfab9 100644 --- a/core/init.lua +++ b/core/init.lua @@ -138,7 +138,7 @@ local quit -- This function is useful for modifying user scripts (such as -- *~/.textadept/init.lua* and *~/.textadept/modules/textadept/keys.lua*) on -- the fly without having to restart Textadept. `arg` is set to `nil` when --- reinitializing the Lua State. Any scripts that need to differentiate between +-- reinitializing the Lua state. Any scripts that need to differentiate between -- startup and reset can test `arg`. -- @class function -- @name reset @@ -162,8 +162,8 @@ local timeout -- a handle to that process. -- At the moment, only the Win32 terminal version spawns processes in the same -- thread. --- @param argv A command line string containing the program's name followed by --- arguments to pass to it. `PATH` is searched for program names. +-- @param argv A command line string that contains the program's name followed +-- by arguments to pass to it. `PATH` is searched for program names. -- @param cwd Optional current working directory (cwd) for the child -- process. The default value is `nil`, which inherits the parent's cwd. -- @param env Optional list of environment variables for the child process. @@ -206,7 +206,7 @@ function spawn_proc:wait() end -- Similar to Lua's `io.read()` and blocks for input. *spawn_proc* must still be -- running. If an error occurs while reading, returns `nil`, an error code, and -- an error message. --- Ensure any read operations read all stdout available. The stdout callback +-- Ensure any read operations read all stdout available, as the stdout callback -- function passed to `spawn()` will not be called until the stdout buffer is -- clear. -- @param arg Optional argument similar to those in Lua's `io.read()`, but "n" |