diff --git a/nselib/bit.lua b/nselib/bit.lua index 9085e54c5..967c64186 100644 --- a/nselib/bit.lua +++ b/nselib/bit.lua @@ -15,6 +15,8 @@ local mininteger = require "math".mininteger local _ENV = {} --- Returns the one's complement of a. +-- +-- REPLACEMENT: ~a -- @param a Number. -- @return The one's complement of a. function bnot(a) @@ -22,6 +24,8 @@ function bnot(a) end --- Returns the bitwise and of all its arguments. +-- +-- REPLACEMENT: a & b -- @param ... A variable number of Numbers to and. -- @return The anded result. function band(a, b, ...) @@ -34,6 +38,8 @@ function band(a, b, ...) end --- Returns the bitwise or of all its arguments. +-- +-- REPLACEMENT: a | b -- @param ... A variable number of Numbers to or. -- @return The ored result. function bor(a, b, ...) @@ -46,6 +52,8 @@ function bor(a, b, ...) end --- Returns the bitwise exclusive or of all its arguments. +-- +-- REPLACEMENT: a ~ b -- @param ... A variable number of Numbers to exclusive or. -- @return The exclusive ored result. function bxor(a, b, ...) @@ -58,6 +66,8 @@ function bxor(a, b, ...) end --- Returns a left-shifted by b places. +-- +-- REPLACEMENT: a << b -- @param a Number to perform the shift on. -- @param b Number of shifts. function lshift(a, b) @@ -65,6 +75,8 @@ function lshift(a, b) end --- Returns a right-shifted by b places. +-- +-- REPLACEMENT: a >> b -- @param a Number to perform the shift on. -- @param b Number of shifts. function rshift(a, b) @@ -88,6 +100,8 @@ function arshift(a, b) end --- Returns the integer remainder of a divided by b. +-- +-- REPLACEMENT: a % b -- @param a Dividend. -- @param b Divisor. function mod(a, b)