1
0
mirror of https://github.com/nmap/nmap.git synced 2026-02-15 18:06:35 +00:00

Remove module and object prefixes from function names in .luadoc files, as

suggested by jah in http://seclists.org/nmap-dev/2008/q4/0232.html. This makes
@see cross-references to functions in these files work from other modules.
This commit is contained in:
david
2008-10-24 15:57:11 +00:00
parent d20ee8dbbc
commit a2ca60092c
5 changed files with 126 additions and 82 deletions

View File

@@ -25,45 +25,45 @@ module "bit"
--- Cast <code>a</code> to an internal integer type.
-- @param a Number.
function bit.cast(a)
function cast(a)
--- Returns the one's complement of <code>a</code>.
-- @param a Number.
-- @return The one's complement of <code>a</code>.
function bit.bnot(a)
function bnot(a)
--- Returns the bitwise and of all its arguments.
-- @param ... A variable number of Numbers to and.
-- @return The anded result.
function bit.band(...)
function band(...)
--- Returns the bitwise or of all its arguments.
-- @param ... A variable number of Numbers to or.
-- @return The ored result.
function bit.bor(...)
function bor(...)
--- Returns the bitwise exclusive or of all its arguments.
-- @param ... A variable number of Numbers to exclusive or.
-- @return The exclusive ored result.
function bit.bxor(...)
function bxor(...)
--- Returns <code>a</code> left-shifted by <code>b</code> places.
-- @param a Number to perform the shift on.
-- @param b Number of shifts.
function bit.lshift(a, b)
function lshift(a, b)
--- Returns <code>a</code> right-shifted by <code>b</code> places.
-- @param a Number to perform the shift on.
-- @param b Number of shifts.
function bit.rshift(a, b)
function rshift(a, b)
--- Returns <code>a</code> arithmetically right-shifted by <code>b</code>
-- places.
-- @param a Number to perform the shift on.
-- @param b Number of shifts.
function bit.arshift(a, b)
function arshift(a, b)
--- Returns the integer remainder of <code>a</code> divided by <code>b</code>.
-- @param a Dividend.
-- @param b Divisor.
function bit.mod(a, b)
function mod(a, b)