aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormitchell <70453897+667e-11@users.noreply.github.com>2017-08-16 22:52:43 -0400
committermitchell <70453897+667e-11@users.noreply.github.com>2017-08-16 22:52:43 -0400
commit1066e39969f454bcc24b64386201c7a861f93a23 (patch)
tree20faf3dbd05baff82a7f4d0badcb1c147e8ee241
parent8f16d5c9f0b7938594fd30742d993e7cea99ec29 (diff)
downloadtextadept-1066e39969f454bcc24b64386201c7a861f93a23.tar.gz
textadept-1066e39969f454bcc24b64386201c7a861f93a23.zip
Mention that buffer's API is derived from Scintilla and provide docs link.
-rw-r--r--core/.buffer.luadoc6
1 files changed, 5 insertions, 1 deletions
diff --git a/core/.buffer.luadoc b/core/.buffer.luadoc
index 38896403..03a7c710 100644
--- a/core/.buffer.luadoc
+++ b/core/.buffer.luadoc
@@ -6,6 +6,10 @@
-- Constants are documented in the fields they apply to.
-- While you can work with individual buffer instances, it is really only useful
-- to work with the global one.
+-- Many of these functions and fields are derived from the Scintilla editing
+-- component, and additional information can be found on the Scintilla website:
+-- [http://scintilla.org/ScintillaDoc.html](
+-- http://scintilla.org/ScintillaDoc.html)
-- @field additional_caret_fore (number)
-- The foreground color, in "0xBBGGRR" format, of additional carets.
-- @field additional_carets_blink (bool)
@@ -159,7 +163,7 @@
-- The default value is `buffer.ALPHA_NOALPHA`, for no alpha.
-- @field caret_line_frame (number)
-- The caret line's frame width in pixels.
--- When non-zero, the line that contains the caret is framed instead of
+-- When non-zero, the line that contains the caret is framed instead of
-- colored in. The `buffer.caret_line_back` and `buffer.caret_line_back_alpha`
-- properties apply to the frame.
-- The default value is `0`.