diff --git a/nselib/bin.luadoc b/nselib/bin.luadoc index 6f899d4c8..75df11570 100644 --- a/nselib/bin.luadoc +++ b/nselib/bin.luadoc @@ -2,9 +2,9 @@ -- Pack and unpack binary data. -- -- A problem script authors often face is the necessity of encoding values --- into binary data. For example after analyzing a protocol the starting +-- into binary data. For example after analyzing a protocol the starting -- point to write a script could be a hex dump, which serves as a preamble --- to every sent packet. Although it is possible to work with the +-- to every sent packet. Although it is possible to work with the -- functionality Lua provides, it's not very convenient. Therefore NSE includes -- Binlib, based on lpack (http://www.tecgraf.puc-rio.br/~lhf/ftp/lua/) -- by Luiz Henrique de Figueiredo. @@ -35,7 +35,7 @@ -- * > big endian modifier -- * = native endian modifier -- --- Note that the endian operators work as modifiers to all the +-- Note that the endian operators work as modifiers to all the -- characters following them in the format string. module "bin" @@ -65,7 +65,7 @@ function pack(format, ...) -- like in pack, except if used with A, -- B, or H, in which cases the number tells -- unpack how many bytes to read. unpack stops if --- either the format string or the binary data string are exhausted. +-- either the format string or the binary data string are exhausted. -- @param format Format string, used to unpack values out of data string. -- @param data String containing packed data. -- @param init Optional starting position within the string. diff --git a/nselib/lfs.luadoc b/nselib/lfs.luadoc index 71ae04976..2c935a634 100644 --- a/nselib/lfs.luadoc +++ b/nselib/lfs.luadoc @@ -8,7 +8,7 @@ module "lfs" --- Returns a directory iterator listing the contents of the given path -- Each time the iterator is called with dir_obj it returns a directory entry's --- name as a string, or nil if there are no more entries. +-- name as a string, or nil if there are no more entries. -- -- @param path string containing the directory to list -- @return iterator function returning the next file or nil when done diff --git a/nselib/nmap.luadoc b/nselib/nmap.luadoc index d7cf6ad35..34ef77eca 100644 --- a/nselib/nmap.luadoc +++ b/nselib/nmap.luadoc @@ -4,7 +4,7 @@ -- The nmap module is an interface with Nmap's internal functions -- and data structures. The API provides target host details such as port -- states and version detection results. It also offers an interface to the --- Nsock library for efficient network I/O. +-- Nsock library for efficient network I/O. -- @copyright Same as Nmap--See http://nmap.org/book/man-legal.html module "nmap" @@ -18,7 +18,7 @@ function debugging() --- Determines whether Nmap was compiled with SSL support. -- --- This can be used to avoid sending SSL probes when SSL is not available. +-- This can be used to avoid sending SSL probes when SSL is not available. -- @return True if Nmap was compiled with SSL support, false otherwise. function have_ssl() @@ -102,10 +102,10 @@ function get_interface() function get_interface_info(interface_name) --- Lists network interfaces --- +-- -- This script enumerates all network interfaces and returns a list of tables --- containing information about every interface. --- +-- containing information about every interface. +-- -- Keys of each table: -- * device The interface name, can be an interface alias. -- * shortname A simple short name of the device. @@ -116,17 +116,17 @@ function get_interface_info(interface_name) -- * broadcast The string representing the broadcast address assigned to the interface if the interface type is "ethernet" and if the used address is IPv4, otherwise it is nil. -- * up The state of the interface, possible values are "up" or "down". -- * mtu The MTU size of the interface. --- +-- -- @return Array of tables containing information about every discovered interface. -- @usage local interfaces, err = nmap.list_interfaces() function list_interfaces() --- Returns the TTL (time to live) value selected by the --ttl option -- --- If there is no value specified or if the value specified with the --ttl +-- If there is no value specified or if the value specified with the --ttl -- option is out of the range 0 to 255 (inclusive) this function returns 64, --- which is the default TTL for an IP packet. This function would be most --- useful in crafting packets, which we want to comply with the selected +-- which is the default TTL for an IP packet. This function would be most +-- useful in crafting packets, which we want to comply with the selected -- Nmap TTL value. -- -- @return A number containing the TTL value @@ -370,7 +370,7 @@ function condvar(object) -- @param handler User cleanup function (optional). -- @usage -- local result, socket, try, catch --- +-- -- result = "" -- socket = nmap.new_socket() -- catch = function() @@ -520,7 +520,7 @@ function send(data) -- * "CANCELLED": The operation was cancelled. -- * "KILL": For example the script scan is aborted due to a faulty script. -- * "EOF": An EOF was read (probably will not occur for a send operation). --- @param host The hostname or IP address to send to. +-- @param host The hostname or IP address to send to. -- @param port The port number to send to. -- @param data The data to send. -- @return Status (true or false). diff --git a/nselib/openssl.luadoc b/nselib/openssl.luadoc index c6c0f0d6a..80a2cc43d 100644 --- a/nselib/openssl.luadoc +++ b/nselib/openssl.luadoc @@ -45,7 +45,7 @@ function bignum_clear_bit(bignum, position) --- Gets the state of the bit at position in bignum. -- @param bignum bignum to operate on. -- @param position Bit position. --- @return True if the selected bit is set, false otherwise. +-- @return True if the selected bit is set, false otherwise. function bignum_is_bit_set(bignum, position) --- Converts a binary-encoded string into a bignum.