From 28b41de2f491ef598197823c04fc7e86ae76a625 Mon Sep 17 00:00:00 2001 From: Akianonymus Date: Sun, 28 Aug 2022 12:30:35 +0530 Subject: fragment | Implement better autocmd management | refactor add a all_buffers option - colorizer will activate on all buffers, empty or not, still respect filetypes option handle errors when detach is called multiple times from the same buffer use bufdelete and bufdelete to remove the autocmds use a more efficient compile parse_fn function use custom ldoc template to generate vim help --- doc/modules/colorizer.buffer_utils.html | 222 ++++++++++++++++++++++++++++++++ 1 file changed, 222 insertions(+) create mode 100644 doc/modules/colorizer.buffer_utils.html (limited to 'doc/modules/colorizer.buffer_utils.html') diff --git a/doc/modules/colorizer.buffer_utils.html b/doc/modules/colorizer.buffer_utils.html new file mode 100644 index 0000000..f2f75fe --- /dev/null +++ b/doc/modules/colorizer.buffer_utils.html @@ -0,0 +1,222 @@ + + + + + colorizer Docs + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Module colorizer.buffer_utils

+

Helper functions to highlight buffer smartly

+

+ +

+ + +

Functions

+ + + + + + + + + +
highlight_buffer (buf, ns, lines, line_start, options)Highlight the buffer region.
rehighlight_buffer (buf, options)Rehighlight the buffer if colorizer is active
+

Tables

+ + + + + +
HIGHLIGHT_MODE_NAMESHighlight mode which will be use to render the colour
+

Fields

+ + + + + +
DEFAULT_NAMESPACEDefault namespace used in highlight_buffer and colorizer.attach_to_buffer.
+ +
+
+ + +

Functions

+ +
+
+ + highlight_buffer (buf, ns, lines, line_start, options) +
+
+ Highlight the buffer region. + Highlight starting from line_start (0-indexed) for each line described by lines in the + buffer buf and attach it to the namespace ns. + + +

Parameters:

+
    +
  • buf + number: buffer id +
    • +
  • ns + number: The namespace id. Default is DEFAULT_NAMESPACE. Create it with vim.api.create_namespace +
    • +
  • lines + table: the lines to highlight from the buffer. +
    • +
  • line_start + number: line_start should be 0-indexed +
    • +
  • options + table: Configuration options as described in setup +
    • +
+ + + + + +
+
+ + rehighlight_buffer (buf, options) +
+
+ Rehighlight the buffer if colorizer is active + + +

Parameters:

+
    +
  • buf + number: Buffer number +
    • +
  • options + table: Buffer options +
    • +
+ + + + + +
+
+

Tables

+ +
+
+ + HIGHLIGHT_MODE_NAMES +
+
+ Highlight mode which will be use to render the colour + + +

Fields:

+
    +
  • background + + + +
    • +
  • foreground + + + +
    • +
  • virtualtext + + + +
    • +
+ + + + + +
+
+

Fields

+ +
+
+ + DEFAULT_NAMESPACE +
+
+ Default namespace used in highlight_buffer and colorizer.attach_to_buffer. + + + + + +

See also:

+ + + +
+
+ + +
+
+
+generated by LDoc 1.4.6 +Last updated 2022-09-03 17:24:13 +
+
+ + -- cgit v1.2.3-70-g09d2