update docs

Firanel · Jun 8, 2022 · 64ab676 · 64ab676
1 parent d654048
commit 64ab676
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 6 deletions.
diff --git a/docs/classes/Color.html b/docs/classes/Color.html
@@ -225,6 +225,10 @@ <h2><a href="#Methods">Methods</a></h2>
 	<td class="summary">Get string representation of color.</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#Color:band">Color:band (a, b)</a></td>
+	<td class="summary">Apply rgb mask to color, providing backwards compatibility for Lua 5.1 and LuaJIT 2.1.0-beta3 (e.g.</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#Color:isColor">Color:isColor (color)</a></td>
 	<td class="summary">Check whether <code>color</code> is a Color.</td>
 	</tr>
@@ -1343,6 +1347,41 @@ <h3>See also:</h3>
     </ul>
 
 
+</dd>
+    <dt>
+    <a name = "Color:band"></a>
+    <strong>Color:band (a, b)</strong>
+    </dt>
+    <dd>
+    Apply rgb mask to color, providing backwards compatibility for Lua 5.1 and LuaJIT 2.1.0-beta3 (e.g.  inside Neovim), which don't provide native support for bitwise operators.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">a</span>
+            <span class="types"><a class="type" href="../classes/Color.html#">Color</a> or <span class="type">number</span></span>
+         color or mask
+        </li>
+        <li><span class="parameter">b</span>
+            <span class="types"><a class="type" href="../classes/Color.html#">Color</a> or <span class="type">number</span></span>
+         color or mask (if a and b are colors b is used as mask)
+        </li>
+    </ul>
+
+    <h3>Returns:</h3>
+    <ol>
+
+           <span class="types"><a class="type" href="../classes/Color.html#">Color</a></span>
+        new color
+    </ol>
+
+
+
+    <h3>Usage:</h3>
+    <ul>
+        <pre class="example"><span class="keyword">local</span> new_col = Color.band(color, <span class="number">0xff00ff</span>) <span class="comment">-- get new color without the green channel</span></pre>
+    </ul>
+
 </dd>
     <dt>
     <a name = "Color:isColor"></a>
@@ -1383,7 +1422,7 @@ <h3>Usage:</h3>
 </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 2022-02-05 10:49:30 </i>
+<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/index.html b/docs/index.html
@@ -84,7 +84,7 @@ <h2>Topics</h2>
 </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 2022-02-05 10:49:30 </i>
+<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/lua-color.colors.X11.html b/docs/modules/lua-color.colors.X11.html
@@ -76,7 +76,7 @@ <h3>Usage:</h3>
 </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 2022-02-05 10:49:30 </i>
+<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/lua-color.colors.html b/docs/modules/lua-color.colors.html
@@ -197,7 +197,7 @@ <h3>Usage:</h3>
 </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 2022-02-05 10:49:30 </i>
+<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/modules/lua-color.terminal.html b/docs/modules/lua-color.terminal.html
@@ -260,7 +260,7 @@ <h2 class="section-header "><a name="Fields"></a>Fields</h2>
 </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 2022-02-05 10:49:30 </i>
+<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

diff --git a/docs/topics/README.md.html b/docs/topics/README.md.html
@@ -269,7 +269,7 @@ <h3>Terminal colors</h3>
 </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 2022-02-05 10:49:30 </i>
+<i style="float:right;">Last updated 2022-06-08 20:37:27 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>