aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAkianonymus <anonymus.aki@gmail.com>2022-09-13 21:32:45 +0530
committerAki <anonymus.aki@gmail.com>2022-09-14 11:47:08 +0530
commit87ea253ae36fb195b7e723a266dbb1f28e0b87bc (patch)
tree3688c40c2ae8edacdc442bef7744cbcb25dd5780 /doc
parentbuffer_utils: A very vague commit message (diff)
Seperate sass code
Diffstat (limited to 'doc')
-rw-r--r--doc/colorizer.txt118
-rw-r--r--doc/index.html5
-rw-r--r--doc/modules/colorizer.buffer_utils.html1
-rw-r--r--doc/modules/colorizer.color_utils.html111
-rw-r--r--doc/modules/colorizer.html1
-rw-r--r--doc/modules/colorizer.matcher_utils.html1
-rw-r--r--doc/modules/colorizer.sass.html188
-rw-r--r--doc/modules/colorizer.trie.html1
-rw-r--r--doc/modules/utils.html1
9 files changed, 262 insertions, 165 deletions
diff --git a/doc/colorizer.txt b/doc/colorizer.txt
index 87a3a90..2cc2d6e 100644
--- a/doc/colorizer.txt
+++ b/doc/colorizer.txt
@@ -351,14 +351,6 @@ Functions: ~
|color_name_parser| - Grab all the colour values from
`vim.api.nvim_get_color_map` and create a lookup table.
- |sass_cleanup| - Cleanup sass variables
-
- |sass_update_variables| - Parse the given lines for sass variabled and add
- to SASS[buf].DEFINITIONS_ALL.
-
- |sass_name_parser| - Parse the given line for sass color names
- check for value in SASS[buf].DEFINITIONS_ALL
-
|rgb_function_parser| - Parse for rgb() css function and return rgb hex.
|rgba_function_parser| - Parse for rgba() css function and return rgb hex.
@@ -401,53 +393,6 @@ color_name_parser({line}, {i}, {opts}) *colorizer.color_utils.color_name_parser*
-sass_cleanup({buf}) *colorizer.color_utils.sass_cleanup*
- Cleanup sass variables
-
- Parameters: ~
- {buf} - number
-
-
-
-
- *colorizer.color_utils.sass_update_variables*
-sass_update_variables({buf}, {line_start}, {line_end}, {lines}, {color_parser},
-{options}, {options_local})
- Parse the given lines for sass variabled and add to
- SASS[buf].DEFINITIONS_ALL.
-
- which is then used in |sass_name_parser|
- If lines are not given, then fetch the lines with line_start and line_end
-
-
- Parameters: ~
- {buf} - number
- {line_start} - number
- {line_end} - number
- {lines} - table|nil
- {color_parser} - function|boolean
- {options} - table: Buffer options
- {options_local} - table|nil: Buffer local variables
-
- returns:~
- boolean
-
-
-
-sass_name_parser({line}, {i}, {buf}) *colorizer.color_utils.sass_name_parser*
- Parse the given line for sass color names
- check for value in SASS[buf].DEFINITIONS_ALL
-
- Parameters: ~
- {line} - string: Line to parse
- {i} - number: Index of line from where to start parsing
- {buf} - number
-
- returns:~
- number or nil, string or nil
-
-
-
rgb_function_parser({line}, {i}) *colorizer.color_utils.rgb_function_parser*
Parse for rgb() css function and return rgb hex.
@@ -569,6 +514,69 @@ make_matcher({options}) *colorizer.matcher_utils.make_matcher*
==============================================================================
+SASS *colorizer.sass-introduction*
+
+Helper functions to parse sass color variables
+
+
+==============================================================================
+LUA API *colorizer.sass-lua-api*
+
+Functions: ~
+ |sass_cleanup| - Cleanup sass variables and watch handlers
+
+ |sass_name_parser| - Parse the given line for sass color names
+ check for value in SASS[buf].DEFINITIONS_ALL
+
+ |sass_update_variables| - Parse the given lines for sass variabled and add
+ to SASS[buf].DEFINITIONS_ALL.
+
+
+sass_cleanup({buf}) *colorizer.sass.sass_cleanup*
+ Cleanup sass variables and watch handlers
+
+ Parameters: ~
+ {buf} - number
+
+
+
+sass_name_parser({line}, {i}, {buf}) *colorizer.sass.sass_name_parser*
+ Parse the given line for sass color names
+ check for value in SASS[buf].DEFINITIONS_ALL
+
+ Parameters: ~
+ {line} - string: Line to parse
+ {i} - number: Index of line from where to start parsing
+ {buf} - number
+
+ returns:~
+ number or nil, string or nil
+
+
+
+
+ *colorizer.sass.sass_update_variables*
+sass_update_variables({buf}, {line_start}, {line_end}, {lines}, {color_parser},
+{options}, {options_local})
+ Parse the given lines for sass variabled and add to
+ SASS[buf].DEFINITIONS_ALL.
+
+ which is then used in |sass_name_parser|
+ If lines are not given, then fetch the lines with line_start and line_end
+
+
+ Parameters: ~
+ {buf} - number
+ {line_start} - number
+ {line_end} - number
+ {lines} - table|nil
+ {color_parser} - function|boolean
+ {options} - table: Buffer options
+ {options_local} - table|nil: Buffer local variables
+
+
+
+==============================================================================
TRIE *colorizer.trie-introduction*
Trie implementation in luajit.
diff --git a/doc/index.html b/doc/index.html
index 6042cb2..2b3efa5 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -35,6 +35,7 @@
<li><a href="modules/colorizer.buffer_utils.html">buffer_utils</a></li>
<li><a href="modules/colorizer.color_utils.html">color_utils</a></li>
<li><a href="modules/colorizer.matcher_utils.html">matcher_utils</a></li>
+ <li><a href="modules/colorizer.sass.html">sass</a></li>
<li><a href="modules/colorizer.trie.html">trie</a></li>
<li><a href="modules/utils.html">utils</a></li>
</ul>
@@ -64,6 +65,10 @@
<td class="summary">Helper functions for colorizer to enable required parsers</td>
</tr>
<tr>
+ <td class="name" nowrap><a href="modules/colorizer.sass.html">colorizer.sass</a></td>
+ <td class="summary">Helper functions to parse sass color variables</td>
+ </tr>
+ <tr>
<td class="name" nowrap><a href="modules/colorizer.trie.html">colorizer.trie</a></td>
<td class="summary">Trie implementation in luajit.</td>
</tr>
diff --git a/doc/modules/colorizer.buffer_utils.html b/doc/modules/colorizer.buffer_utils.html
index 8d7beaa..e433609 100644
--- a/doc/modules/colorizer.buffer_utils.html
+++ b/doc/modules/colorizer.buffer_utils.html
@@ -44,6 +44,7 @@
<li><strong>buffer_utils</strong></li>
<li><a href="../modules/colorizer.color_utils.html">color_utils</a></li>
<li><a href="../modules/colorizer.matcher_utils.html">matcher_utils</a></li>
+ <li><a href="../modules/colorizer.sass.html">sass</a></li>
<li><a href="../modules/colorizer.trie.html">trie</a></li>
<li><a href="../modules/utils.html">utils</a></li>
</ul>
diff --git a/doc/modules/colorizer.color_utils.html b/doc/modules/colorizer.color_utils.html
index 6e26961..f685731 100644
--- a/doc/modules/colorizer.color_utils.html
+++ b/doc/modules/colorizer.color_utils.html
@@ -42,6 +42,7 @@
<li><a href="../modules/colorizer.buffer_utils.html">buffer_utils</a></li>
<li><strong>color_utils</strong></li>
<li><a href="../modules/colorizer.matcher_utils.html">matcher_utils</a></li>
+ <li><a href="../modules/colorizer.sass.html">sass</a></li>
<li><a href="../modules/colorizer.trie.html">trie</a></li>
<li><a href="../modules/utils.html">utils</a></li>
</ul>
@@ -68,19 +69,6 @@
<td class="summary">Grab all the colour values from <code>vim.api.nvim_get_color_map</code> and create a lookup table.</td>
</tr>
<tr>
- <td class="name" nowrap><a href="#sass_cleanup">sass_cleanup (buf)</a></td>
- <td class="summary">Cleanup sass variables</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#sass_update_variables">sass_update_variables (buf, line_start, line_end, lines, color_parser, options, options_local)</a></td>
- <td class="summary">Parse the given lines for sass variabled and add to SASS[buf].DEFINITIONS_ALL.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#sass_name_parser">sass_name_parser (line, i, buf)</a></td>
- <td class="summary">Parse the given line for sass color names
- check for value in SASS[buf].DEFINITIONS_ALL</td>
- </tr>
- <tr>
<td class="name" nowrap><a href="#rgb_function_parser">rgb_function_parser (line, i)</a></td>
<td class="summary">Parse for rgb() css function and return rgb hex.</td>
</tr>
@@ -170,103 +158,6 @@
</dd>
<dt>
- <a name = "sass_cleanup"></a>
- <strong>sass_cleanup (buf)</strong>
- </dt>
- <dd>
- Cleanup sass variables
-
-
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">buf</span>
- number
- </li>
- </ul>
-
-
-
-
-
-</dd>
- <dt>
- <a name = "sass_update_variables"></a>
- <strong>sass_update_variables (buf, line_start, line_end, lines, color_parser, options, options_local)</strong>
- </dt>
- <dd>
- Parse the given lines for sass variabled and add to SASS[buf].DEFINITIONS<em>ALL.
- which is then used in |sass</em>name<em>parser|
- If lines are not given, then fetch the lines with line</em>start and line_end
-
-
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">buf</span>
- number
- </li>
- <li><span class="parameter">line_start</span>
- number
- </li>
- <li><span class="parameter">line_end</span>
- number
- </li>
- <li><span class="parameter">lines</span>
- table|nil
- </li>
- <li><span class="parameter">color_parser</span>
- function|boolean
- </li>
- <li><span class="parameter">options</span>
- table: Buffer options
- </li>
- <li><span class="parameter">options_local</span>
- table|nil: Buffer local variables
- </li>
- </ul>
-
- <h3>Returns:</h3>
- <ol>
-
- boolean
- </ol>
-
-
-
-
-</dd>
- <dt>
- <a name = "sass_name_parser"></a>
- <strong>sass_name_parser (line, i, buf)</strong>
- </dt>
- <dd>
- Parse the given line for sass color names
- check for value in SASS[buf].DEFINITIONS_ALL
-
-
- <h3>Parameters:</h3>
- <ul>
- <li><span class="parameter">line</span>
- string: Line to parse
- </li>
- <li><span class="parameter">i</span>
- number: Index of line from where to start parsing
- </li>
- <li><span class="parameter">buf</span>
- number
- </li>
- </ul>
-
- <h3>Returns:</h3>
- <ol>
-
- number|nil, string|nil
- </ol>
-
-
-
-
-</dd>
- <dt>
<a name = "rgb_function_parser"></a>
<strong>rgb_function_parser (line, i)</strong>
</dt>
diff --git a/doc/modules/colorizer.html b/doc/modules/colorizer.html
index edc06db..14b976f 100644
--- a/doc/modules/colorizer.html
+++ b/doc/modules/colorizer.html
@@ -44,6 +44,7 @@
<li><a href="../modules/colorizer.buffer_utils.html">buffer_utils</a></li>
<li><a href="../modules/colorizer.color_utils.html">color_utils</a></li>
<li><a href="../modules/colorizer.matcher_utils.html">matcher_utils</a></li>
+ <li><a href="../modules/colorizer.sass.html">sass</a></li>
<li><a href="../modules/colorizer.trie.html">trie</a></li>
<li><a href="../modules/utils.html">utils</a></li>
</ul>
diff --git a/doc/modules/colorizer.matcher_utils.html b/doc/modules/colorizer.matcher_utils.html
index 5a5514f..bdf0188 100644
--- a/doc/modules/colorizer.matcher_utils.html
+++ b/doc/modules/colorizer.matcher_utils.html
@@ -42,6 +42,7 @@
<li><a href="../modules/colorizer.buffer_utils.html">buffer_utils</a></li>
<li><a href="../modules/colorizer.color_utils.html">color_utils</a></li>
<li><strong>matcher_utils</strong></li>
+ <li><a href="../modules/colorizer.sass.html">sass</a></li>
<li><a href="../modules/colorizer.trie.html">trie</a></li>
<li><a href="../modules/utils.html">utils</a></li>
</ul>
diff --git a/doc/modules/colorizer.sass.html b/doc/modules/colorizer.sass.html
new file mode 100644
index 0000000..45ec0d8
--- /dev/null
+++ b/doc/modules/colorizer.sass.html
@@ -0,0 +1,188 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+<head>
+ <title>colorizer Docs</title>
+ <link rel="stylesheet" href="../ldoc.css" type="text/css" />
+</head>
+<body>
+
+<div id="container">
+
+<div id="product">
+ <div id="product_logo"></div>
+ <div id="product_name"><big><b></b></big></div>
+ <div id="product_description"></div>
+</div> <!-- id="product" -->
+
+
+<div id="main">
+
+
+<!-- Menu -->
+
+<div id="navigation">
+<br/>
+<h1>colorizer</h1>
+
+<ul>
+ <li><a href="../index.html">Index</a></li>
+</ul>
+
+<h2>Contents</h2>
+<ul>
+<li><a href="#Functions">Functions</a></li>
+</ul>
+
+
+<h2>Modules</h2>
+<ul class="nowrap">
+ <li><a href="../modules/colorizer.html">colorizer</a></li>
+ <li><a href="../modules/colorizer.buffer_utils.html">buffer_utils</a></li>
+ <li><a href="../modules/colorizer.color_utils.html">color_utils</a></li>
+ <li><a href="../modules/colorizer.matcher_utils.html">matcher_utils</a></li>
+ <li><strong>sass</strong></li>
+ <li><a href="../modules/colorizer.trie.html">trie</a></li>
+ <li><a href="../modules/utils.html">utils</a></li>
+</ul>
+
+</div>
+
+<div id="content">
+
+<h1>Module <code>colorizer.sass</code></h1>
+<p>Helper functions to parse sass color variables</p>
+<p>
+
+</p>
+
+
+<h2><a href="#Functions">Functions</a></h2>
+<table class="function_list">
+ <tr>
+ <td class="name" nowrap><a href="#sass_cleanup">sass_cleanup (buf)</a></td>
+ <td class="summary">Cleanup sass variables and watch handlers</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#sass_name_parser">sass_name_parser (line, i, buf)</a></td>
+ <td class="summary">Parse the given line for sass color names
+ check for value in SASS[buf].DEFINITIONS_ALL</td>
+ </tr>
+ <tr>
+ <td class="name" nowrap><a href="#sass_update_variables">sass_update_variables (buf, line_start, line_end, lines, color_parser, options, options_local)</a></td>
+ <td class="summary">Parse the given lines for sass variabled and add to SASS[buf].DEFINITIONS_ALL.</td>
+ </tr>
+</table>
+
+<br/>
+<br/>
+
+
+ <h2 class="section-header "><a name="Functions"></a>Functions</h2>
+
+ <dl class="function">
+ <dt>
+ <a name = "sass_cleanup"></a>
+ <strong>sass_cleanup (buf)</strong>
+ </dt>
+ <dd>
+ Cleanup sass variables and watch handlers
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">buf</span>
+ number
+ </li>
+ </ul>
+
+
+
+
+
+</dd>
+ <dt>
+ <a name = "sass_name_parser"></a>
+ <strong>sass_name_parser (line, i, buf)</strong>
+ </dt>
+ <dd>
+ Parse the given line for sass color names
+ check for value in SASS[buf].DEFINITIONS_ALL
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">line</span>
+ string: Line to parse
+ </li>
+ <li><span class="parameter">i</span>
+ number: Index of line from where to start parsing
+ </li>
+ <li><span class="parameter">buf</span>
+ number
+ </li>
+ </ul>
+
+ <h3>Returns:</h3>
+ <ol>
+
+ number|nil, string|nil
+ </ol>
+
+
+
+
+</dd>
+ <dt>
+ <a name = "sass_update_variables"></a>
+ <strong>sass_update_variables (buf, line_start, line_end, lines, color_parser, options, options_local)</strong>
+ </dt>
+ <dd>
+ Parse the given lines for sass variabled and add to SASS[buf].DEFINITIONS<em>ALL.
+ which is then used in |sass</em>name<em>parser|
+ If lines are not given, then fetch the lines with line</em>start and line_end
+
+
+ <h3>Parameters:</h3>
+ <ul>
+ <li><span class="parameter">buf</span>
+ number
+ </li>
+ <li><span class="parameter">line_start</span>
+ number
+ </li>
+ <li><span class="parameter">line_end</span>
+ number
+ </li>
+ <li><span class="parameter">lines</span>
+ table|nil
+ </li>
+ <li><span class="parameter">color_parser</span>
+ function|boolean
+ </li>
+ <li><span class="parameter">options</span>
+ table: Buffer options
+ </li>
+ <li><span class="parameter">options_local</span>
+ table|nil: Buffer local variables
+ </li>
+ </ul>
+
+
+
+
+
+</dd>
+</dl>
+
+
+</div> <!-- id="content" -->
+</div> <!-- id="main" -->
+<div id="about">
+<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
+<i style="float:right;">Last updated - September </i>
+</div> <!-- id="about" -->
+</div> <!-- id="container" -->
+</body>
+</html>
diff --git a/doc/modules/colorizer.trie.html b/doc/modules/colorizer.trie.html
index e5fc981..25cd3cb 100644
--- a/doc/modules/colorizer.trie.html
+++ b/doc/modules/colorizer.trie.html
@@ -38,6 +38,7 @@
<li><a href="../modules/colorizer.buffer_utils.html">buffer_utils</a></li>
<li><a href="../modules/colorizer.color_utils.html">color_utils</a></li>
<li><a href="../modules/colorizer.matcher_utils.html">matcher_utils</a></li>
+ <li><a href="../modules/colorizer.sass.html">sass</a></li>
<li><strong>trie</strong></li>
<li><a href="../modules/utils.html">utils</a></li>
</ul>
diff --git a/doc/modules/utils.html b/doc/modules/utils.html
index 3e6fb0a..8a5479a 100644
--- a/doc/modules/utils.html
+++ b/doc/modules/utils.html
@@ -42,6 +42,7 @@
<li><a href="../modules/colorizer.buffer_utils.html">buffer_utils</a></li>
<li><a href="../modules/colorizer.color_utils.html">color_utils</a></li>
<li><a href="../modules/colorizer.matcher_utils.html">matcher_utils</a></li>
+ <li><a href="../modules/colorizer.sass.html">sass</a></li>
<li><a href="../modules/colorizer.trie.html">trie</a></li>
<li><strong>utils</strong></li>
</ul>