diff options
Diffstat (limited to 'core')
| -rw-r--r-- | core/.buffer.luadoc | 17 | ||||
| -rw-r--r-- | core/.iconv.luadoc | 8 | ||||
| -rw-r--r-- | core/events.lua | 4 |
3 files changed, 16 insertions, 13 deletions
diff --git a/core/.buffer.luadoc b/core/.buffer.luadoc index e9aadb9a..4f1dc7cc 100644 --- a/core/.buffer.luadoc +++ b/core/.buffer.luadoc @@ -1150,8 +1150,7 @@ function marker_delete_all(buffer, marker) end function marker_delete_handle(buffer, handle) end --- --- Returns a bit-mask that represents the markers that were added to line number --- *line*. +-- Returns a bit-mask that represents the markers on line number *line*. -- The first bit is set if marker number 1 is present, the second bit for marker -- number 2, and so on. -- @param buffer A buffer. @@ -1168,16 +1167,16 @@ function marker_get(buffer, line) end function marker_handle_from_line(buffer, line, n) end --- --- Returns the line number that marker handle *handle*, returned by --- `buffer.marker_add()`, was added to, or `-1` if the line was not found. +-- Returns the line number of the line that contains the marker with handle +-- *handle* (returned `buffer.marker_add()`), or `-1` if the line was not found. -- @param buffer A buffer. -- @param handle The identifier of a marker returned by `buffer.marker_add()`. -- @return number function marker_line_from_handle(buffer, handle) end --- --- Returns the first line number, starting at line number *line*, that has had --- all of the markers represented by marker bit-mask *marker_mask* added to it. +-- Returns the first line number, starting at line number *line*, that contains +-- all of the markers represented by marker bit-mask *marker_mask*. -- Returns `-1` if no line was found. -- The first bit is set if marker 1 is set, the second bit for marker 2, etc., -- up to marker 32. @@ -1197,8 +1196,8 @@ function marker_next(buffer, line, marker_mask) end function marker_number_from_line(buffer, line, n) end --- --- Returns the last line number, before or on line number *line*, that has had --- all of the markers represented by marker bit-mask *marker_mask* added to it. +-- Returns the last line number, before or on line number *line*, that contains +-- all of the markers represented by marker bit-mask *marker_mask*. -- Returns `-1` if no line was found. -- The first bit is set if marker 1 is set, the second bit for marker 2, etc., -- up to marker 32. @@ -1761,7 +1760,7 @@ function word_start_position(buffer, pos, only_word_chars) end function delete(buffer) end --- --- Creates and returns a new buffer. +-- Creates a new buffer, displays it in the current view, and returns it. -- Emits a `BUFFER_NEW` event. -- @return the new buffer. -- @class function diff --git a/core/.iconv.luadoc b/core/.iconv.luadoc index 162938e8..189e83bc 100644 --- a/core/.iconv.luadoc +++ b/core/.iconv.luadoc @@ -6,9 +6,9 @@ module('string') --- --- Converts string *text* from encoding *old* to encoding *new* using iconv, --- returning the string result. --- Valid encodings are [GNU iconv's encodings][] and include: +-- Converts string *text* from encoding *old* to encoding *new* using GNU +-- libiconv, returning the string result. +-- Valid encodings are [GNU libiconv's encodings][] and include: -- -- * European: ASCII, ISO-8859-{1,2,3,4,5,7,9,10,13,14,15,16}, KOI8-R, KOI8-U, -- KOI8-RU, CP{1250,1251,1252,1253,1254,1257}, CP{850,866,1131}, @@ -31,7 +31,7 @@ module('string') -- * Unicode: UTF-8, UCS-2, UCS-2BE, UCS-2LE, UCS-4, UCS-4BE, UCS-4LE, UTF-16, -- UTF-16BE, UTF-16LE, UTF-32, UTF-32BE, UTF-32LE, UTF-7, C99, JAVA. -- --- [GNU iconv's encodings]: http://www.gnu.org/software/libiconv/ +-- [GNU libiconv's encodings]: http://www.gnu.org/software/libiconv/ -- @param text The text to convert. -- @param new The string encoding to convert to. -- @param old The string encoding to convert from. diff --git a/core/events.lua b/core/events.lua index eb60c99b..322ae9d3 100644 --- a/core/events.lua +++ b/core/events.lua @@ -62,9 +62,11 @@ local M = {} -- * _`position`_: The position the list was displayed at. -- @field BUFFER_AFTER_SWITCH (string) -- Emitted right after switching to another buffer. +-- The buffer being switched to is `buffer`. -- Emitted by [`view.goto_buffer()`](). -- @field BUFFER_BEFORE_SWITCH (string) -- Emitted right before switching to another buffer. +-- The buffer being switched from is `buffer`. -- Emitted by [`view.goto_buffer()`](). -- @field BUFFER_DELETED (string) -- Emitted after deleting a buffer. @@ -297,9 +299,11 @@ local M = {} -- Emitted on startup and by [`view.split()`](). -- @field VIEW_BEFORE_SWITCH (string) -- Emitted right before switching to another view. +-- The view being switched from is `view`. -- Emitted by [`ui.goto_view()`](). -- @field VIEW_AFTER_SWITCH (string) -- Emitted right after switching to another view. +-- The view being switched to is `view`. -- Emitted by [`ui.goto_view()`](). -- @field ZOOM (string) -- Emitted after changing [`view.zoom`](). |