aboutsummaryrefslogtreecommitdiffhomepage
path: root/core/.view.luadoc
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+orbitalquark@users.noreply.github.com>2020-11-30 11:04:27 -0500
committerGravatar mitchell <70453897+orbitalquark@users.noreply.github.com>2020-11-30 11:04:27 -0500
commitc352e1e45b98f31fc0fb67c7296c7ada77732777 (patch)
tree1891b567482eecd3fa7597b38690d43ad6646f05 /core/.view.luadoc
parent4d661eb109e242db21deb2667b60b3a3f48c2fc7 (diff)
Updated LuaDoc.
Diffstat (limited to 'core/.view.luadoc')
-rw-r--r--core/.view.luadoc8
1 files changed, 5 insertions, 3 deletions
diff --git a/core/.view.luadoc b/core/.view.luadoc
index 11b0c6ca..8fb460de 100644
--- a/core/.view.luadoc
+++ b/core/.view.luadoc
@@ -60,7 +60,7 @@
-- @field call_tip_fore_hlt (number, Write-only)
-- A call tip's highlighted text foreground color, in "0xBBGGRR" format.
-- @field call_tip_pos_start (number, Write-only)
--- The position in which backspacing beyond it hides a visible call tip.
+-- The position at which backspacing beyond it hides a visible call tip.
-- @field call_tip_position (boolean)
-- Display a call tip above the current line instead of below it.
-- The default value is `false`.
@@ -460,7 +460,8 @@
-- The alternative string representations of characters.
-- Representations are displayed in the same way control characters are. Use
-- the empty string for the '\0' character when assigning its representation.
--- Characters are strings, not numeric codes.
+-- Characters are strings, not numeric codes, and can be multi-byte
+-- characters.
-- Call [`view.clear_representation()`]() to remove a representation.
-- @field rgba_image_height (number)
-- The height of the RGBA image to be defined using
@@ -1027,7 +1028,8 @@ function call_tip_show(view, pos, text) end
function clear_registered_images(view) end
---
--- Removes the alternate string representation for character *char*.
+-- Removes the alternate string representation for character *char* (which may
+-- be a multi-byte character).
-- @param view A view.
-- @param char The string character in `buffer.representations` to remove the
-- alternate string representation for.