From 615e32c94fdb4c83f06b65902f10434a1bd0d495 Mon Sep 17 00:00:00 2001
From: Ashkan Kiani
Date: Fri, 18 Oct 2019 09:43:18 -0700
Subject: Update docs and luadocs
---
doc/modules/colorizer.html | 89 ++++++++++++++++++++++++++++++++++++++++++----
doc/modules/nvim.html | 66 ++++++++++++++++++++++++++++++++++
doc/modules/trie.html | 3 +-
3 files changed, 150 insertions(+), 8 deletions(-)
create mode 100644 doc/modules/nvim.html
(limited to 'doc/modules')
diff --git a/doc/modules/colorizer.html b/doc/modules/colorizer.html
index adce131..e02d18a 100644
--- a/doc/modules/colorizer.html
+++ b/doc/modules/colorizer.html
@@ -40,6 +40,7 @@
Modules
@@ -55,17 +56,29 @@
- highlight_buffer (buf[, ns=DEFAULT_NAMESPACE], lines, line_start[, options]) |
+ highlight_buffer (buf[, ns=DEFAULT_NAMESPACE], lines, line_start, options) |
Highlight the buffer region. |
- attach_to_buffer ([buf=0[, options]]) |
+ attach_to_buffer ([buf=0|nil[, options]]) |
Attach to a buffer and continuously highlight changes. |
+ detach_from_buffer ([buf=0|nil[, ns=DEFAULT_NAMESPACE]]) |
+ Stop highlighting the current buffer. |
+
+
setup ([filetypes={'*'}[, default_options]]) |
Easy to use function if you want the full setup without fine grained control. |
+
+ reload_all_buffers () |
+ Reload all of the currently active highlighted buffers. |
+
+
+ get_buffer_options ([buf=0|nil]) |
+ Return the currently active buffer options. |
+
@@ -84,7 +97,7 @@
-
- highlight_buffer (buf[, ns=DEFAULT_NAMESPACE], lines, line_start[, options])
+ highlight_buffer (buf[, ns=DEFAULT_NAMESPACE], lines, line_start, options)
-
Highlight the buffer region.
@@ -114,7 +127,6 @@ buffer `buf` and attach it to the namespace `ns`.
- options
Configuration options as described in `setup`
- (optional)
@@ -129,7 +141,7 @@ buffer `buf` and attach it to the namespace `ns`.
-
- attach_to_buffer ([buf=0[, options]])
+ attach_to_buffer ([buf=0|nil[, options]])
-
Attach to a buffer and continuously highlight changes.
@@ -140,7 +152,7 @@ buffer `buf` and attach it to the namespace `ns`.
- buf
integer
A value of 0 implies the current buffer.
- (default 0)
+ (default 0|nil)
- options
Configuration options as described in `setup`
@@ -156,6 +168,33 @@ buffer `buf` and attach it to the namespace `ns`.
+
+ -
+
+ detach_from_buffer ([buf=0|nil[, ns=DEFAULT_NAMESPACE]])
+
+ -
+ Stop highlighting the current buffer.
+
+
+
Parameters:
+
+ - buf
+ integer
+ A value of 0 or nil implies the current buffer.
+ (default 0|nil)
+
+ - ns
+ integer
+ the namespace id.
+ (default DEFAULT_NAMESPACE)
+
+
+
+
+
+
+
-
@@ -198,6 +237,42 @@ buffer `buf` and attach it to the namespace `ns`.
require'colorizer'.setup()
+
+ -
+
+ reload_all_buffers ()
+
+ -
+ Reload all of the currently active highlighted buffers.
+
+
+
+
+
+
+
+
+ -
+
+ get_buffer_options ([buf=0|nil])
+
+ -
+ Return the currently active buffer options.
+
+
+
Parameters:
+
+ - buf
+ integer
+ A value of 0 or nil implies the current buffer.
+ (default 0|nil)
+
+
+
+
+
+
+
@@ -230,7 +305,7 @@ buffer `buf` and attach it to the namespace `ns`.
generated by LDoc 1.4.6
-
Last updated 2019-10-17 16:25:49
+
Last updated 2019-10-18 09:40:19
+
+
+
+
+
+
+
+
+
+
+
+
+
+
ldoc
+
+
+
+
+
+
Modules
+
+
+
+
+
+
+
Module nvim
+
Module of magic functions for nvim
+
+
+
+
+
+
+
+
+
+
+
+
+
+
generated by LDoc 1.4.6
+
Last updated 2019-10-18 09:40:19
+
+
+
diff --git a/doc/modules/nvim.html b/doc/modules/nvim.html
new file mode 100644
index 0000000..8009822
--- /dev/null
+++ b/doc/modules/nvim.html
@@ -0,0 +1,66 @@
+
+
+
+