diff options
author | 2019-08-31 10:22:16 -0400 | |
---|---|---|
committer | 2019-08-31 10:22:16 -0400 | |
commit | d08d115b1d1ebb4a154e441ff16b619bad4a87b0 (patch) | |
tree | 56da515c7be4a4d17565c7e8c05596824cbcf318 | |
parent | aa851db5cf7c6d9179247ad87dd497340b80e25f (diff) |
Updated LuaDoc.
-rw-r--r-- | core/.buffer.luadoc | 4 | ||||
-rw-r--r-- | modules/lua/api | 2 |
2 files changed, 5 insertions, 1 deletions
diff --git a/core/.buffer.luadoc b/core/.buffer.luadoc index d5cfd084..503cb1c7 100644 --- a/core/.buffer.luadoc +++ b/core/.buffer.luadoc @@ -203,6 +203,10 @@ -- * `buffer.CARETSTYLE_BLOCK_ALWAYS` -- A block caret in both insert and overtype mode. -- +-- Any block setting may be combined with `buffer.CARETSTYLE_BLOCK_AFTER` via +-- bitwise OR (`|`) in order to draw the caret after the end of a selection, +-- as opposed to just inside it. +-- -- The default value is `buffer.CARETSTYLE_LINE`. -- @field caret_width (number) -- The line caret's pixel width in insert mode, either `0`, `1`, `2`, or `3`. diff --git a/modules/lua/api b/modules/lua/api index 3f798c81..6c27b0f9 100644 --- a/modules/lua/api +++ b/modules/lua/api @@ -446,7 +446,7 @@ caret_line_visible buffer.caret_line_visible (bool)\nColor the background of the caret_line_visible_always buffer.caret_line_visible_always (bool)\nAlways show the caret line, even when the window is not in focus.\nThe default value is `false`, showing the line only when the window is in\nfocus. caret_period buffer.caret_period (number)\nThe time between caret blinks in milliseconds.\nA value of `0` stops blinking.\nThe default value is `500`. caret_sticky buffer.caret_sticky (number)\nThe caret's preferred horizontal position when moving between lines.\n\n* `buffer.CARETSTICKY_OFF`\n Use the same position the caret had on the previous line.\n* `buffer.CARETSTICKY_ON`\n Use the last position the caret was moved to via the mouse, left/right\n arrow keys, home/end keys, etc. Typing text does not affect the position.\n* `buffer.CARETSTICKY_WHITESPACE`\n Use the position the caret had on the previous line, but prior to any\n inserted indentation.\n\nThe default value is `buffer.CARETSTICKY_OFF`. -caret_style buffer.caret_style (number)\nThe caret's visual style.\n\n* `buffer.CARETSTYLE_INVISIBLE`\n No caret.\n* `buffer.CARETSTYLE_LINE`\n A line caret.\n* `buffer.CARETSTYLE_BLOCK`\n A block caret.\n* `buffer.CARETSTYLE_BLOCK_ALWAYS`\n A block caret in both insert and overtype mode.\n\nThe default value is `buffer.CARETSTYLE_LINE`. +caret_style buffer.caret_style (number)\nThe caret's visual style.\n\n* `buffer.CARETSTYLE_INVISIBLE`\n No caret.\n* `buffer.CARETSTYLE_LINE`\n A line caret.\n* `buffer.CARETSTYLE_BLOCK`\n A block caret.\n* `buffer.CARETSTYLE_BLOCK_ALWAYS`\n A block caret in both insert and overtype mode.\n\nAny block setting may be combined with `buffer.CARETSTYLE_BLOCK_AFTER` via\nbitwise OR (`|`) in order to draw the caret after the end of a selection,\nas opposed to just inside it.\n\nThe default value is `buffer.CARETSTYLE_LINE`. caret_width buffer.caret_width (number)\nThe line caret's pixel width in insert mode, either `0`, `1`, `2`, or `3`.\nThe default value is `1`. ceil math.ceil(x)\nReturns the smallest integral value larger than or equal to `x`. char string.char(ยทยทยท)\nReceives zero or more integers. Returns a string with length equal to\nthe number of arguments, in which each character has the internal numerical\ncode equal to its corresponding argument.\n\nNumerical codes are not necessarily portable across platforms. |