diff options
| author | Akianonymus <anonymus.aki@gmail.com> | 2022-09-15 10:00:00 +0530 |
|---|---|---|
| committer | Akianonymus <anonymus.aki@gmail.com> | 2022-09-15 13:51:38 +0530 |
| commit | cf4f33f5ea34f9c4e9975299b094f1a2b8b34aa0 (patch) | |
| tree | 3f2558419b2643ac7af8f4abe8e67db478d64309 /doc/modules/colorizer.matcher.html | |
| parent | fix(gitignore) Add doc/tags to .gitignore (diff) | |
Better structure and naming | Misc improvements
Diffstat (limited to 'doc/modules/colorizer.matcher.html')
| -rw-r--r-- | doc/modules/colorizer.matcher.html | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/doc/modules/colorizer.matcher.html b/doc/modules/colorizer.matcher.html new file mode 100644 index 0000000..9b2b67e --- /dev/null +++ b/doc/modules/colorizer.matcher.html @@ -0,0 +1,147 @@ +<!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.html">buffer</a></li> + <li><a href="../modules/colorizer.color.html">color</a></li> + <li><strong>matcher</strong></li> + <li><a href="../modules/colorizer.sass.html">sass</a></li> + <li><a href="../modules/colorizer.tailwind.html">tailwind</a></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.matcher</code></h1> +<p>Helper functions for colorizer to enable required parsers</p> +<p> + +</p> + + +<h2><a href="#Functions">Functions</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#compile">compile (matchers, matchers_trie)</a></td> + <td class="summary">Form a trie stuct with the given prefixes</td> + </tr> + <tr> + <td class="name" nowrap><a href="#make">make (options)</a></td> + <td class="summary">Parse the given options and return a function with enabled parsers.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Functions"></a>Functions</h2> + + <dl class="function"> + <dt> + <a name = "compile"></a> + <strong>compile (matchers, matchers_trie)</strong> + </dt> + <dd> + Form a trie stuct with the given prefixes + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">matchers</span> + table: List of prefixes, {"rgb", "hsl"} + </li> + <li><span class="parameter">matchers_trie</span> + table: Table containing information regarding non-trie based parsers + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + function: function which will just parse the line for enabled parsers + </ol> + + + + +</dd> + <dt> + <a name = "make"></a> + <strong>make (options)</strong> + </dt> + <dd> + Parse the given options and return a function with enabled parsers. +if no parsers enabled then return false +Do not try make the function again if it is present in the cache + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">options</span> + table: options created in <a href="../modules/colorizer.html#setup">colorizer.setup</a> + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + function|boolean: function which will just parse the line for enabled parsers + </ol> + + + + +</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> |