Update missing docs

Author: edubart

.gitignore

@@ -1,2 +1,3 @@
 *.out
 play.lua
+*.rock

bint.lua

@@ -839,7 +839,7 @@ function bint.ceil(x)
   end
 end
 
--- Wrap around bits of an integer (discarding left bits) considering bints.
+--- Wrap around bits of an integer (discarding left bits) considering bints.
 -- @param x A bint or a lua integer.
 -- @param y Number of right bits to preserve.
 function bint.bwrap(x, y)
@@ -853,7 +853,7 @@ function bint.bwrap(x, y)
   end
 end
 
--- Rotate left integer x by y bits considering bints.
+--- Rotate left integer x by y bits considering bints.
 -- @param x A bint or a lua integer.
 -- @param y Number of bits to rotate.
 function bint.brol(x, y)
@@ -867,7 +867,7 @@ function bint.brol(x, y)
   end
 end
 
--- Rotate right integer x by y bits considering bints.
+--- Rotate right integer x by y bits considering bints.
 -- @param x A bint or a lua integer.
 -- @param y Number of bits to rotate.
 function bint.bror(x, y)

docs/index.html

@@ -290,6 +290,18 @@ <h2><a href="#Functions">Functions</a></h2>
 	<td class="summary">Take ceil of a number considering bints.</td>
 	</tr>
 	<tr>
+	<td class="name" nowrap><a href="#bwrap">bwrap (x, y)</a></td>
+	<td class="summary">Wrap around bits of an integer (discarding left bits) considering bints.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#brol">brol (x, y)</a></td>
+	<td class="summary">Rotate left integer x by y bits considering bints.</td>
+	</tr>
+	<tr>
+	<td class="name" nowrap><a href="#bror">bror (x, y)</a></td>
+	<td class="summary">Rotate right integer x by y bits considering bints.</td>
+	</tr>
+	<tr>
 	<td class="name" nowrap><a href="#trunc">trunc (x)</a></td>
 	<td class="summary">Truncate a number to a bint.</td>
 	</tr>
@@ -1279,6 +1291,75 @@ <h3>Parameters:</h3>
 
 
 
+</dd>
+    <dt>
+    <a name = "bwrap"></a>
+    <strong>bwrap (x, y)</strong>
+    </dt>
+    <dd>
+    Wrap around bits of an integer (discarding left bits) considering bints.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">x</span>
+         A bint or a lua integer.
+        </li>
+        <li><span class="parameter">y</span>
+         Number of right bits to preserve.
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "brol"></a>
+    <strong>brol (x, y)</strong>
+    </dt>
+    <dd>
+    Rotate left integer x by y bits considering bints.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">x</span>
+         A bint or a lua integer.
+        </li>
+        <li><span class="parameter">y</span>
+         Number of bits to rotate.
+        </li>
+    </ul>
+
+
+
+
+
+</dd>
+    <dt>
+    <a name = "bror"></a>
+    <strong>bror (x, y)</strong>
+    </dt>
+    <dd>
+    Rotate right integer x by y bits considering bints.
+
+
+    <h3>Parameters:</h3>
+    <ul>
+        <li><span class="parameter">x</span>
+         A bint or a lua integer.
+        </li>
+        <li><span class="parameter">y</span>
+         Number of bits to rotate.
+        </li>
+    </ul>
+
+
+
+
+
 </dd>
     <dt>
     <a name = "trunc"></a>
@@ -2282,7 +2363,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 2020-07-10 10:21:42 </i>
+<i style="float:right;">Last updated 2020-07-10 10:43:35 </i>
 </div> <!-- id="about" -->
 </div> <!-- id="container" -->
 </body>

examples/simple.lua

@@ -1,4 +1,4 @@
-local bint = require 'bint'(1024) -- use 256 bits integers
+local bint = require 'bint'(256) -- use 256 bits integers
 local x = bint(1)
 x = x << 128
 print(x) -- outputs: 340282366920938463463374607431768211456