PenTest/nmap
1
0
Fork 0
mirror of https://github.com/nmap/nmap.git synced 2025-12-07 13:11:28 +00:00
Code Issues Projects Releases Wiki Activity

NSEdoc cleanup

Browse Source 
Mostly splitting function summaries (the first paragraph of NSEdoc) from
the body of the description to make the summary indexes shorter and
easier to scan.

Also fixed some unbalanced code tags like <code>foo</table>
This commit is contained in:
dmiller
2014-09-02 18:23:06 +00:00
parent 165595517f
commit 2692746c42
13 changed files with 106 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
nselib/creds.lua
View File

@@ -277,7 +277,7 @@ Credentials = {
--- Returns a credential iterator --- Returns a credential iterator
-- --
-- @see State -- @see State
-- @param state mask containing values from the <Code>State</code> table -- @param state mask containing values from the <code>State</code> table
-- @return credential iterator, returning a credential each time it's -- @return credential iterator, returning a credential each time it's
-- called. Unless filtered by the state mask all credentials -- called. Unless filtered by the state mask all credentials
-- for the host, port match are iterated over. -- for the host, port match are iterated over.

1
nselib/iscsi.lua
View File

@@ -423,6 +423,7 @@ Packet = {
} }
--- The communication class handles socket reads and writes --- The communication class handles socket reads and writes
--
-- In addition it keeps track of both immediate packets and the amount of read -- In addition it keeps track of both immediate packets and the amount of read
-- packets and updates cmdsn and expstatsn accordingly. -- packets and updates cmdsn and expstatsn accordingly.
Comm = { Comm = {

1
nselib/jdwp.lua
View File

@@ -586,6 +586,7 @@ function invokeStaticMethod(socket,id,classID,methodID,numberOfArguments,argumen
end end
--- NewInstance Command (4) --- NewInstance Command (4)
--
-- Creates a new object of this type, invoking the specified constructor. -- Creates a new object of this type, invoking the specified constructor.
-- The constructor method ID must be a member of the class type. -- The constructor method ID must be a member of the class type.
-- --

1
nselib/json.lua
View File

@@ -163,6 +163,7 @@ json = P(json); -- compile the grammar
--- Parses JSON data into a Lua object. --- Parses JSON data into a Lua object.
--
-- This is the method you probably want to use if you use this library from a -- This is the method you probably want to use if you use this library from a
-- script. -- script.
--@param data a json string --@param data a json string

1
nselib/lfs.luadoc
View File

@@ -7,6 +7,7 @@
module "lfs" module "lfs"
--- Returns a directory iterator listing the contents of the given path --- 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 -- 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.
-- --

4
nselib/msrpc.lua
View File

@@ -213,7 +213,9 @@ function stop_smb(state)
smb.stop(state) smb.stop(state)
end end
--- Bind to a MSRPC interface. Two common interfaces are SAML and SRVSVC, and can be found as --- Bind to a MSRPC interface.
--
-- Two common interfaces are SAML and SRVSVC, and can be found as
-- constants at the top of this file. Once this function has successfully returned, any MSRPC -- constants at the top of this file. Once this function has successfully returned, any MSRPC
-- call can be made (provided it doesn't depend on results from other MSRPC calls). -- call can be made (provided it doesn't depend on results from other MSRPC calls).
-- --

133
nselib/msrpctypes.lua
View File

@@ -740,7 +740,8 @@ function marshall_int64(int64)
return result return result
end end
--- Marshall an int32, which has the following format: --- Marshall an int32
--
-- <code> [in] uint32 var</code> -- <code> [in] uint32 var</code>
-- --
-- This is simply an integer inserted into the buffer, nothing fancy. -- This is simply an integer inserted into the buffer, nothing fancy.
@@ -774,7 +775,8 @@ function marshall_int32_array(data)
return result return result
end end
--- Marshall an int16, which has the following format: --- Marshall an int16
--
-- <code> [in] uint16 var</code> -- <code> [in] uint16 var</code>
-- --
-- This is simply an integer inserted into the buffer, nothing fancy. -- This is simply an integer inserted into the buffer, nothing fancy.
@@ -797,7 +799,8 @@ function marshall_int16(int16, pad)
return result return result
end end
--- Marshall an int8, which has the following format: --- Marshall an int8
--
-- <code> [in] uint8 var</code> -- <code> [in] uint8 var</code>
-- --
-- This is simply an integer inserted into the buffer, nothing fancy. -- This is simply an integer inserted into the buffer, nothing fancy.
@@ -904,7 +907,9 @@ function unmarshall_int8(data, pos, pad)
return pos, value return pos, value
end end
--- Marshall a pointer to an int64. If the pointer is null, it simply marshalls the --- Marshall a pointer to an int64.
--
-- If the pointer is null, it simply marshalls the
-- integer '0'. Otherwise, it uses a referent id followed by the integer. -- integer '0'. Otherwise, it uses a referent id followed by the integer.
-- --
--@param int64 The value of the integer pointer --@param int64 The value of the integer pointer
@@ -919,7 +924,8 @@ function marshall_int64_ptr(int64)
return result return result
end end
--- Marshall a pointer to an int32, which has the following format: --- Marshall a pointer to an int32
--
-- <code> [in,out] uint32 *ptr</code> -- <code> [in,out] uint32 *ptr</code>
-- --
-- If the pointer is null, it simply marshalls the integer '0'. Otherwise, -- If the pointer is null, it simply marshalls the integer '0'. Otherwise,
@@ -937,7 +943,8 @@ function marshall_int32_ptr(int32)
return result return result
end end
--- Marshall a pointer to an int16, which has the following format: --- Marshall a pointer to an int16
--
-- <code> [in,out] uint16 *ptr</code> -- <code> [in,out] uint16 *ptr</code>
-- --
-- If the pointer is null, it simply marshalls the integer '0'. Otherwise, -- If the pointer is null, it simply marshalls the integer '0'. Otherwise,
@@ -956,7 +963,8 @@ function marshall_int16_ptr(int16, pad)
return result return result
end end
--- Marshall a pointer to an int8, which has the following format: --- Marshall a pointer to an int8
--
-- <code> [in,out] uint8 *ptr</code> -- <code> [in,out] uint8 *ptr</code>
-- --
-- If the pointer is null, it simply marshalls the integer '0'. Otherwise, -- If the pointer is null, it simply marshalls the integer '0'. Otherwise,
@@ -1219,8 +1227,9 @@ function unmarshall_NTTIME_ptr(data, pos)
return pos, time return pos, time
end end
---Unmarshall a SYSTEMTIME structure, converting it to a standard representation. The structure is a ---Unmarshall a SYSTEMTIME structure, converting it to a standard representation.
-- follows: --
--The structure is as follows:
-- --
-- <code> -- <code>
-- typedef struct _SYSTEMTIME { -- typedef struct _SYSTEMTIME {
@@ -1520,7 +1529,7 @@ end
-- (dependencies: MISC) -- (dependencies: MISC)
---------------------------------- ----------------------------------
---Unmarshall a struct with the following definition: ---Unmarshall a dom_sid struct
-- --
--<code> --<code>
-- typedef [public,gensize,noprint,noejs,nosize] struct { -- typedef [public,gensize,noprint,noejs,nosize] struct {
@@ -1574,7 +1583,7 @@ function unmarshall_dom_sid2_ptr(data, pos)
return unmarshall_ptr(ALL, data, pos, unmarshall_dom_sid2, {}) return unmarshall_ptr(ALL, data, pos, unmarshall_dom_sid2, {})
end end
---Marshall a struct with the following definition: ---Marshall a dom_sid struct
-- --
--<code> --<code>
-- typedef [public,gensize,noprint,noejs,nosize] struct { -- typedef [public,gensize,noprint,noejs,nosize] struct {
@@ -1860,7 +1869,7 @@ function unmarshall_lsa_SidType(data, pos)
end end
---Convert a <code>lsa_SidType</code> value to a string that can be shown to the user. This is ---Convert a <code>lsa_SidType</code> value to a string that can be shown to the user. This is
-- based on the <code>_str</table> table. -- based on the <code>_str</code> table.
-- --
--@param val The string value (returned by the <code>unmarshall_</code> function) to convert. --@param val The string value (returned by the <code>unmarshall_</code> function) to convert.
--@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found. --@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found.
@@ -1926,7 +1935,7 @@ function unmarshall_lsa_LookupNamesLevel(data, pos)
end end
---Convert a <code>lsa_LookupNamesLevel</code> value to a string that can be shown to the user. This is ---Convert a <code>lsa_LookupNamesLevel</code> value to a string that can be shown to the user. This is
-- based on the <code>_str</table> table. -- based on the <code>_str</code> table.
-- --
--@param val The string value (returned by the <code>unmarshall_</code> function) to convert. --@param val The string value (returned by the <code>unmarshall_</code> function) to convert.
--@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found. --@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found.
@@ -1940,7 +1949,7 @@ function lsa_LookupNamesLevel_tostr(val)
return result return result
end end
---Marshall a struct with the following definition: ---Marshall a lsa_TranslatedSid2 struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -1984,7 +1993,7 @@ local function marshall_lsa_TranslatedSid2(location, sid_type, rid, sid_index, u
return result return result
end end
---Unmarshall a struct with the following definition: ---Unmarshall a lsa_TranslatedSid2 struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -2025,7 +2034,7 @@ local function unmarshall_lsa_TranslatedSid2(location, data, pos, result)
return pos, result return pos, result
end end
---Marshall a struct with the following definition: ---Marshall a lsa_TranslatedName2 struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -2104,7 +2113,7 @@ local function unmarshall_lsa_TranslatedName2(location, data, pos, result)
end end
---Marshall a struct with the following definition: ---Marshall a lsa_TransSidArray2 struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -2134,7 +2143,7 @@ function marshall_lsa_TransSidArray2(sids)
return result return result
end end
---Marshall a struct with the following definition: ---Marshall a lsa_StringLarge struct
-- --
--<code> --<code>
-- typedef [public] struct { -- typedef [public] struct {
@@ -2175,7 +2184,7 @@ local function unmarshall_lsa_StringLarge(location, data, pos, result)
return pos, str return pos, str
end end
---Unmarshall a struct with the following definition: ---Unmarshall a lsa_DomainInfo struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -2215,7 +2224,7 @@ local function unmarshall_lsa_DomainInfo(location, data, pos, result)
return pos, result return pos, result
end end
---Unmarshall a struct with the following definition: ---Unmarshall a lsa_RefDomainList struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -2260,7 +2269,7 @@ function unmarshall_lsa_RefDomainList_ptr(data, pos)
return pos, result return pos, result
end end
---Unmarshall a struct with the following definition: ---Unmarshall a lsa_TransSidArray2 struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -2283,7 +2292,7 @@ function unmarshall_lsa_TransSidArray2(data, pos)
return pos, result return pos, result
end end
---Marshall a struct with the following definition: ---Marshall a lsa_QosInfo struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -2311,7 +2320,7 @@ function marshall_lsa_QosInfo()
return result return result
end end
---Marshall a struct with the following definition: ---Marshall a lsa_ObjectAttribute struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -2343,7 +2352,7 @@ function marshall_lsa_ObjectAttribute()
return result return result
end end
---Marshall a struct with the following definition: ---Marshall a lsa_SidPtr struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -2367,7 +2376,7 @@ local function marshall_lsa_SidPtr(location, sid)
return result return result
end end
---Marshall a struct with the following definition: ---Marshall a lsa_SidArray struct
-- --
--<code> --<code>
-- typedef [public] struct { -- typedef [public] struct {
@@ -2395,10 +2404,13 @@ function marshall_lsa_SidArray(sids)
return result return result
end end
---Unmarshall a struct with the following definition: ---Unmarshall a lsa_SidPtr struct
--
--<code>
-- typedef struct { -- typedef struct {
-- dom_sid2 *sid; -- dom_sid2 *sid;
-- } lsa_SidPtr; -- } lsa_SidPtr;
--</code>
-- --
--@param location The part of the pointer wanted, either HEAD (for the data itself), BODY --@param location The part of the pointer wanted, either HEAD (for the data itself), BODY
-- (for nothing, since this isn't a pointer), or ALL (for the data). Generally, unless the -- (for nothing, since this isn't a pointer), or ALL (for the data). Generally, unless the
@@ -2415,7 +2427,7 @@ function unmarshall_lsa_SidPtr(location, data, pos, result)
return unmarshall_ptr(location, data, pos, unmarshall_dom_sid2, {}, result) return unmarshall_ptr(location, data, pos, unmarshall_dom_sid2, {}, result)
end end
---Unmarshall a struct with the following definition: ---Unmarshall a lsa_SidArray struct
-- --
-- typedef [public] struct { -- typedef [public] struct {
-- [range(0,1000)] uint32 num_sids; -- [range(0,1000)] uint32 num_sids;
@@ -2434,7 +2446,7 @@ function unmarshall_lsa_SidArray(data, pos)
return pos, sidarray return pos, sidarray
end end
---Marshall a struct with the following definition: ---Marshall a lsa_TransNameArray2 struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -2556,7 +2568,7 @@ function unmarshall_winreg_AccessMask(data, pos)
end end
---Convert a <code>winreg_AccessMask</code> value to a string that can be shown to the user. This is ---Convert a <code>winreg_AccessMask</code> value to a string that can be shown to the user. This is
-- based on the <code>_str</table> table. -- based on the <code>_str</code> table.
-- --
--@param val The string value (returned by the <code>unmarshall_</code> function) to convert. --@param val The string value (returned by the <code>unmarshall_</code> function) to convert.
--@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found. --@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found.
@@ -2667,7 +2679,7 @@ function unmarshall_winreg_Type_ptr(data, pos)
end end
---Convert a <code>winreg_Type</code> value to a string that can be shown to the user. This is ---Convert a <code>winreg_Type</code> value to a string that can be shown to the user. This is
-- based on the <code>_str</table> table. -- based on the <code>_str</code> table.
-- --
--@param val The string value (returned by the <code>unmarshall_</code> function) to convert. --@param val The string value (returned by the <code>unmarshall_</code> function) to convert.
--@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found. --@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found.
@@ -2883,7 +2895,7 @@ function unmarshall_srvsvc_ShareType(data, pos)
end end
---Convert a <code>srvsvc_ShareType</code> value to a string that can be shown to the user. This is ---Convert a <code>srvsvc_ShareType</code> value to a string that can be shown to the user. This is
-- based on the <code>_str</table> table. -- based on the <code>_str</code> table.
-- --
--@param val The string value (returned by the <code>unmarshall_</code> function) to convert. --@param val The string value (returned by the <code>unmarshall_</code> function) to convert.
--@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found. --@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found.
@@ -3107,7 +3119,9 @@ local function unmarshall_srvsvc_NetShareInfo2(location, data, pos, result)
return pos, result return pos, result
end end
---Marshall a NetShareCtr (container) type 0. It is a simple array with the following definition: ---Marshall a NetShareCtr (container) type 0.
--
--It is a simple array with the following definition:
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -3168,7 +3182,9 @@ function unmarshall_srvsvc_NetShareCtr0(data, pos)
return pos, result return pos, result
end end
---Marshall a NetShareCtr (container) type 1. It is a simple array with the following definition: ---Marshall a NetShareCtr (container) type 1.
--
--It is a simple array with the following definition:
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -3212,7 +3228,9 @@ function marshall_srvsvc_NetShareCtr1(NetShareCtr1)
end end
---Marshall a NetShareCtr (container) type 2. It is a simple array with the following definition: ---Marshall a NetShareCtr (container) type 2.
--
--It is a simple array with the following definition:
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -3441,7 +3459,9 @@ local function unmarshall_srvsvc_NetSessInfo10(location, data, pos, result)
return pos, result return pos, result
end end
---Marshall a NetSessCtr (session container) type 10. It is a simple array with the following definition: ---Marshall a NetSessCtr (session container) type 10.
--
--It is a simple array with the following definition:
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -3693,7 +3713,7 @@ function unmarshall_samr_ConnectAccessMask(data, pos)
end end
---Convert a <code>samr_ConnectAccessMask</code> value to a string that can be shown to the user. This is ---Convert a <code>samr_ConnectAccessMask</code> value to a string that can be shown to the user. This is
-- based on the <code>_str</table> table. -- based on the <code>_str</code> table.
-- --
--@param val The string value (returned by the <code>unmarshall_</code> function) to convert. --@param val The string value (returned by the <code>unmarshall_</code> function) to convert.
--@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found. --@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found.
@@ -3768,7 +3788,7 @@ function unmarshall_samr_DomainAccessMask(data, pos)
end end
---Convert a <code>samr_DomainAccessMask</code> value to a string that can be shown to the user. This is ---Convert a <code>samr_DomainAccessMask</code> value to a string that can be shown to the user. This is
-- based on the <code>_str</table> table. -- based on the <code>_str</code> table.
-- --
--@param val The string value (returned by the <code>unmarshall_</code> function) to convert. --@param val The string value (returned by the <code>unmarshall_</code> function) to convert.
--@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found. --@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found.
@@ -3861,7 +3881,7 @@ function unmarshall_samr_AcctFlags(data, pos)
end end
---Convert a <code>samr_AcctFlags</code> value to a string that can be shown to the user. This is ---Convert a <code>samr_AcctFlags</code> value to a string that can be shown to the user. This is
-- based on the <code>_str</table> table. -- based on the <code>_str</code> table.
-- --
--@param val The string value (returned by the <code>unmarshall_</code> function) to convert. --@param val The string value (returned by the <code>unmarshall_</code> function) to convert.
--@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found. --@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found.
@@ -3926,7 +3946,7 @@ function unmarshall_samr_PasswordProperties(data, pos)
end end
---Convert a <code>samr_PasswordProperties</code> value to a string that can be shown to the user. This is ---Convert a <code>samr_PasswordProperties</code> value to a string that can be shown to the user. This is
-- based on the <code>_str</table> table. -- based on the <code>_str</code> table.
-- --
--@param val The string value (returned by the <code>unmarshall_</code> function) to convert. --@param val The string value (returned by the <code>unmarshall_</code> function) to convert.
--@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found. --@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found.
@@ -3941,7 +3961,7 @@ function samr_PasswordProperties_tostr(val)
end end
---Unmarshall a struct with the following definition: ---Unmarshall a samr_SamEntry struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -3981,7 +4001,7 @@ local function unmarshall_samr_SamEntry(location, data, pos, result)
return pos, result return pos, result
end end
---Unmarshall a struct with the following definition: ---Unmarshall a samr_SamArray struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -4020,7 +4040,7 @@ function unmarshall_samr_SamArray_ptr(data, pos)
return pos, result return pos, result
end end
---Unmarshall a struct with the following definition: ---Unmarshall a samr_DispEntryGeneral struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -4070,7 +4090,7 @@ local function unmarshall_samr_DispEntryGeneral(location, data, pos, result)
return pos, result return pos, result
end end
---Unmarshall a struct with the following definition: ---Unmarshall a samr_DispInfoGeneral struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -4094,7 +4114,7 @@ function unmarshall_samr_DispInfoGeneral(data, pos)
end end
---Unmarshall a struct with the following definition: ---Unmarshall a samr_DispInfo struct
-- --
--<code> --<code>
-- typedef [switch_type(uint16)] union { -- typedef [switch_type(uint16)] union {
@@ -4128,7 +4148,7 @@ function unmarshall_samr_DispInfo(data, pos)
return pos, result return pos, result
end end
---Unmarshall a struct with the following definition: ---Unmarshall a samr_DomInfo1 struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -4158,7 +4178,7 @@ function unmarshall_samr_DomInfo1(data, pos)
return pos, result return pos, result
end end
---Unmarshall a struct with the following definition: ---Unmarshall a samr_DomInfo8 struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -4181,7 +4201,7 @@ function unmarshall_samr_DomInfo8(data, pos)
return pos, result return pos, result
end end
---Unmarshall a struct with the following definition: ---Unmarshall a samr_DomInfo12 struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -4206,7 +4226,7 @@ function unmarshall_samr_DomInfo12(data, pos)
return pos, result return pos, result
end end
---Unmarshall a union with the following definition: ---Unmarshall a samr_DomainInfo union
-- --
--<code> --<code>
-- typedef [switch_type(uint16)] union { -- typedef [switch_type(uint16)] union {
@@ -4268,7 +4288,7 @@ function unmarshall_samr_DomainInfo_ptr(data, pos)
return pos, result return pos, result
end end
---Unmarshall a structure with the following definition: ---Unmarshall a samr_Ids struct
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {
@@ -4352,7 +4372,7 @@ function unmarshall_svcctl_ControlCode(data, pos)
end end
---Convert a <code>svcctl_ControlCode</code> value to a string that can be shown to the user. This is ---Convert a <code>svcctl_ControlCode</code> value to a string that can be shown to the user. This is
-- based on the <code>_str</table> table. -- based on the <code>_str</code> table.
-- --
--@param val The string value (returned by the <code>unmarshall_</code> function) to convert. --@param val The string value (returned by the <code>unmarshall_</code> function) to convert.
--@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found. --@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found.
@@ -4410,7 +4430,7 @@ function unmarshall_svcctl_Type(data, pos)
end end
--[[Convert a <code>svcctl_Type</code> value to a string that can be shown to the user. This is --[[Convert a <code>svcctl_Type</code> value to a string that can be shown to the user. This is
-- based on the <code>_str</table> table. -- based on the <code>_str</code> table.
-- --
--@param val The string value (returned by the <code>unmarshall_</code> function) to convert. --@param val The string value (returned by the <code>unmarshall_</code> function) to convert.
--@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found. --@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found.
@@ -4464,7 +4484,7 @@ function unmarshall_svcctl_State(data, pos)
end end
--[[Convert a <code>svcctl_State</code> value to a string that can be shown to the user. This is --[[Convert a <code>svcctl_State</code> value to a string that can be shown to the user. This is
-- based on the <code>_str</table> table. -- based on the <code>_str</code> table.
-- --
--@param val The string value (returned by the <code>unmarshall_</code> function) to convert. --@param val The string value (returned by the <code>unmarshall_</code> function) to convert.
--@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found. --@return A string suitable for displaying to the user, or <code>nil</code> if it wasn't found.
@@ -4479,8 +4499,9 @@ function svcctl_State_tostr(val)
end]]-- end]]--
---Unmarshall a SERVICE_STATUS struct, converting it to a table. The structure is as ---Unmarshall a SERVICE_STATUS struct, converting it to a table.
-- follows: --
-- The structure is as follows:
-- --
-- <code> -- <code>
-- typedef struct { -- typedef struct {
@@ -4616,7 +4637,9 @@ function marshall_atsvc_DaysOfWeek(flags)
return result return result
end end
---Marshall a JobInfo struct. The structure is as follows: ---Marshall a JobInfo struct.
--
--The structure is as follows:
-- --
--<code> --<code>
-- typedef struct { -- typedef struct {

1
nselib/smb.lua
View File

@@ -460,6 +460,7 @@ function start_raw(host, port)
end end
--- This function will take a string like "a.b.c.d" and return "a", "a.b", "a.b.c", and "a.b.c.d". --- This function will take a string like "a.b.c.d" and return "a", "a.b", "a.b.c", and "a.b.c.d".
--
-- This is used for discovering NetBIOS names. If a NetBIOS name is unknown, the substrings of the -- This is used for discovering NetBIOS names. If a NetBIOS name is unknown, the substrings of the
-- DNS name can be used in this way. -- DNS name can be used in this way.
-- --

3
nselib/ssh1.lua
View File

@@ -41,7 +41,8 @@ check_packet_length = function( buffer )
end end
--- Receives a complete SSH packet, even if fragmented --- Receives a complete SSH packet, even if fragmented
-- this function is an abstraction layer to deal with --
-- This function is an abstraction layer to deal with
-- checking the packet size to know if there is any more -- checking the packet size to know if there is any more
-- data to receive. -- data to receive.
-- --

3
nselib/ssh2.lua
View File

@@ -39,7 +39,8 @@ check_packet_length = function( buffer )
end end
--- Receives a complete SSH packet, even if fragmented --- Receives a complete SSH packet, even if fragmented
-- this function is an abstraction layer to deal with --
-- This function is an abstraction layer to deal with
-- checking the packet size to know if there is any more -- checking the packet size to know if there is any more
-- data to receive. -- data to receive.
-- --

5
nselib/stdnse.lua
View File

@@ -232,6 +232,7 @@ function strsplit(pattern, text)
end end
--- Generate a random string. --- Generate a random string.
--
-- You can either provide your own charset or the function will use -- You can either provide your own charset or the function will use
-- a default one which is [A-Z]. -- a default one which is [A-Z].
-- @param len Length of the string we want to generate. -- @param len Length of the string we want to generate.
@@ -549,7 +550,9 @@ function format_timestamp(t, offset)
end end
--- Format the difference between times <code>t2</code> and <code>t1</code> --- Format the difference between times <code>t2</code> and <code>t1</code>
-- into a string in one of the forms (signs may vary): -- into a string
--
-- String is in one of the forms (signs may vary):
-- * 0s -- * 0s
-- * -4s -- * -4s
-- * +2m38s -- * +2m38s

7
nselib/tab.lua
View File

@@ -71,9 +71,10 @@ function addrow(t, ...)
nextrow(t) nextrow(t)
end end
--- Move on to the next row in the table. If this is not called --- Move on to the next row in the table.
-- then previous column values will be over-written by subsequent --
-- values. -- If this is not called then previous column values will be over-written by
-- subsequent values.
-- @param t The table. -- @param t The table.
function nextrow(t) function nextrow(t)
assert(t) assert(t)

12
nselib/unpwdb.lua
View File

@@ -134,8 +134,9 @@ table_iterator = function(table)
end end
end end
--- Returns the suggested number of seconds to attempt a brute force attack, --- Returns the suggested number of seconds to attempt a brute force attack
-- based on the <code>unpwdb.timelimit</code> script argument, Nmap's timing --
-- Based on the <code>unpwdb.timelimit</code> script argument, Nmap's timing
-- values (<code>-T4</code> etc.) and whether or not a user-defined list is -- values (<code>-T4</code> etc.) and whether or not a user-defined list is
-- used. -- used.
-- --
@@ -209,9 +210,10 @@ local passwords_raw = function()
return true, table_iterator(passtable) return true, table_iterator(passtable)
end end
--- Wraps time and count limits around an iterator. When either limit expires, --- Wraps time and count limits around an iterator.
-- starts returning <code>nil</code>. Calling the iterator with an argument of --
-- "reset" resets the count. -- When either limit expires, starts returning <code>nil</code>. Calling the
-- iterator with an argument of "reset" resets the count.
-- @param time_limit Time limit in seconds. Use 0 or <code>nil</code> for no limit. -- @param time_limit Time limit in seconds. Use 0 or <code>nil</code> for no limit.
-- @param count_limit Count limit in seconds. Use 0 or <code>nil</code> for no limit. -- @param count_limit Count limit in seconds. Use 0 or <code>nil</code> for no limit.
-- @return boolean Status. -- @return boolean Status.