1
0
mirror of https://github.com/nmap/nmap.git synced 2025-12-08 05:31:31 +00:00

Fix some NSEDoc.

This commit is contained in:
david
2010-06-24 17:01:55 +00:00
parent 9c3f61d870
commit 32c8ee9f1f
5 changed files with 28 additions and 28 deletions

View File

@@ -193,7 +193,7 @@ DRDA = {
--- Sends the DRDA over the db2socket
--
-- @param socket DB2Socket over which to send the data
-- @param db2socket DB2Socket over which to send the data
-- @return Status (true or false).
-- @return Error code (if status is false).
send = function( self, db2socket )
@@ -820,7 +820,7 @@ StringUtil =
--
-- @param str string to pad
-- @param chr char to pad with
-- @len the total length of the finnished string
-- @param len the total length of the finnished string
-- @return str string containing the padded string
padWithChar = function( str, chr, len )
if ( len < #str ) then

View File

@@ -4371,7 +4371,7 @@ RASRPC_VERSION = 1
--} ReqTypes;
--- The <code>ReqTypes</code> enumerations indicate the different types of message requests that can be passed in
--the <code>RB_ReqType</code> field of <code>RequestBuffer</code> structure.
-- @see [MS-RRASM] <code>2.2.1.1.18 ReqTypes</code>
-- * [MS-RRASM] <code>2.2.1.1.18 ReqTypes</code>
--####################################################################--
RRAS_RegTypes = {}
RRAS_RegTypes['PORTENUM'] = 21
@@ -4395,9 +4395,9 @@ RRAS_RegTypes['GETNDISWANDRIVERCAPS'] = 111
--- The <code>RequestBuffer</code> is a generic information container used by the <code>RasRpcSubmitRequest</code>
--method to set or retrieve information on RRAS server. This method performs
--serialization of <code>RequestBuffer</code> structure.
-- Note: This structure is not an IDL specification and as such is not translated into NDR.
-- @return Returns a blob of <code>RequestBuffer</code> structure.
-- @note This structure is not an IDL specification and as such is not translated into NDR.
-- @see [MS-RRASM] <code>2.2.1.2.218 RequestBuffer</code>
-- * [MS-RRASM] <code>2.2.1.2.218 RequestBuffer</code>
--####################################################################--
function RRAS_marshall_RequestBuffer(RB_PCBIndex, RB_ReqType, RB_Buffer)
local rb_blob, RB_Dummy, RB_Done, Alignment
@@ -4421,7 +4421,7 @@ local RRAS_DEBUG_LVL = 2 --debug level for rras operations when calling stdnse.p
--####################################################################--
--- RRAS operation numbers.
-- @see [MS-RRASM] <code>3.3.4 Message Processing Events and Sequencing Rules</code>
-- * [MS-RRASM] <code>3.3.4 Message Processing Events and Sequencing Rules</code>
--####################################################################--
RRAS_Opnums = {}
RRAS_Opnums["RasRpcDeleteEntry"] = 5
@@ -4451,7 +4451,7 @@ RRAS_Opnums["RasRpcGetVersion"] = 15
-- @return (status, result)
--* <code>status == true</code> -> <code>result</code> is a blob that represent a <code>pRegBuffer</code> .
--* <code>status == false</code> -> <code>result</code> is a error message that caused the fuzz.
-- @see [MS-RRASM] <code>3.3.4.5 RasRpcSubmitRequest (Opnum 12)</code>
-- * [MS-RRASM] <code>3.3.4.5 RasRpcSubmitRequest (Opnum 12)</code>
--####################################################################--
function RRAS_SubmitRequest(smbstate, pReqBuffer, dwcbBufSize)
--sanity check
@@ -4503,7 +4503,7 @@ DNSSERVER_VERSION = 5
--####################################################################--
---The list of names that are used in (name, value) pairs in DNS Server
--Configuration information is given below.
-- @see [MS-DNSP] <code>3.1.1.1 DNS Server Configuration Information</code>
-- * [MS-DNSP] <code>3.1.1.1 DNS Server Configuration Information</code>
DNSSERVER_ConfInfo =
{
DNSSERVER_IntProp = {},
@@ -4519,7 +4519,7 @@ local DNSSERVER_DEBUG_LVL = 2 --debug level for dnsserver operations when callin
--####################################################################--
--- DNSSERVER operation numbers.
-- @see [MS-DNSP] <code>3.1.4 Message Processing Events and Sequencing Rules</code>
-- * [MS-DNSP] <code>3.1.4 Message Processing Events and Sequencing Rules</code>
--####################################################################--
DNSSERVER_Opnums = {}
DNSSERVER_Opnums['R_DnssrvOperation'] = 0
@@ -4563,7 +4563,7 @@ LONG R_DnssrvQuery(
--data-structure as indicated by <code>result['type_id']</code>.
--* <code>status == false</code> ->
--** <code>result</code> - Is a error message that caused the fuzz.
-- @see [MS-DNSP] <code>3.1.4.2 R_DnssrvQuery (Opnum 1)</code>
-- * [MS-DNSP] <code>3.1.4.2 R_DnssrvQuery (Opnum 1)</code>
--####################################################################--
function DNSSERVER_Query(smbstate, server_name, zone, operation)
local status
@@ -4652,7 +4652,7 @@ end
--####################################################################--
---Generates a random string of the requested length.
--@param length The length of the string to return.
--@param set The set of letters to choose from. Default: ASCII letters and numbers
--@param charset The set of letters to choose from. Default: ASCII letters and numbers
--@return The random string.
--####################################################################--
function random_crap(length, charset)

View File

@@ -396,7 +396,7 @@ Comm = {
--- Encodes a RPC packet
--
-- @param xid number containing the transaction ID
-- @param procedure number containing the procedure to call
-- @param proc number containing the procedure to call
-- @param auth table containing authentication information
-- @param data string containing the packet data
-- @return packet string containing the encoded packet data
@@ -525,7 +525,7 @@ Portmap =
--- Dumps a list of RCP programs from the portmapper
--
-- @param Comm object handles rpc program information and
-- @param comm object handles rpc program information and
-- low-level packet manipulation
-- @return status boolean true on success, false on failure
-- @return result table containing RPC program information or error message
@@ -628,7 +628,7 @@ Portmap =
--- Queries the portmapper for the port of the selected program,
-- protocol and version
--
-- @param Comm object handles rpc program information and
-- @param comm object handles rpc program information and
-- low-level packet manipulation
-- @param program string name of the program
-- @param protocol string containing either "tcp" or "udp"
@@ -749,7 +749,7 @@ Mount = {
--- Requests a list of NFS export from the remote server
--
-- @param Comm object handles rpc program information and
-- @param comm object handles rpc program information and
-- low-level packet manipulation
-- @return status success or failure
-- @return entries table containing a list of share names (strings)
@@ -892,7 +892,7 @@ Mount = {
--- Attempts to mount a remote export in order to get the filehandle
--
-- @param Comm object handles rpc program information and
-- @param comm object handles rpc program information and
-- low-level packet manipulation
-- @param path string containing the path to mount
-- @return status success or failure
@@ -987,7 +987,7 @@ Mount = {
--- Attempts to unmount a remote export in order to get the filehandle
--
-- @param Comm object handles rpc program information and
-- @param comm object handles rpc program information and
-- low-level packet manipulation
-- @param path string containing the path to mount
-- @return status success or failure
@@ -1216,7 +1216,7 @@ NFS = {
--- Decodes the READDIR section of a NFS ReadDir response
--
-- @param Comm object handles rpc program information and
-- @param comm object handles rpc program information and
-- low-level packet manipulation
-- @param data string containing the buffer of bytes read so far
-- @param pos number containing the current offset into data
@@ -1346,7 +1346,7 @@ NFS = {
--- Reads the contents inside a NFS directory
--
-- @param Comm object handles rpc program information and
-- @param comm object handles rpc program information and
-- low-level packet manipulation
-- @param file_handle string containing the filehandle to query
-- @return status true on success, false on failure
@@ -1573,7 +1573,7 @@ NFS = {
--- Gets filesystem stats (Total Blocks, Free Blocks and Available block) on a remote NFS share
--
-- @param Comm object handles rpc program information and
-- @param comm object handles rpc program information and
-- low-level packet manipulation
-- @param file_handle string containing the filehandle to query
-- @return status true on success, false on failure
@@ -1621,7 +1621,7 @@ NFS = {
--- Attempts to decode the attributes section of the reply
--
-- @param Comm object handles rpc program information and
-- @param comm object handles rpc program information and
-- low-level packet manipulation
-- @param data string containing the full statfs reply
-- @param pos number pointing to the statfs section of the reply
@@ -1667,7 +1667,7 @@ NFS = {
--- Gets mount attributes (uid, gid, mode, etc ..) from a remote NFS share
--
-- @param Comm object handles rpc program information and
-- @param comm object handles rpc program information and
-- low-level packet manipulation
-- @param file_handle string containing the filehandle to query
-- @return status true on success, false on failure
@@ -1705,7 +1705,7 @@ NFS = {
--- Attempts to decode the StatFS section of the reply
--
-- @param Comm object handles rpc program information and
-- @param comm object handles rpc program information and
-- low-level packet manipulation
-- @param data string containing the full statfs reply
-- @param pos number pointing to the statfs section of the reply
@@ -1828,7 +1828,7 @@ Helper = {
-- This function must be used to unmount a NFS point
-- mounted by MountPath()
--
-- @param Comm object returned from a previous call to
-- @param mnt_comm object returned from a previous call to
-- MountPath()
-- @param path string containing the path to unmount
-- @return true on success or nil on failure
@@ -1881,7 +1881,7 @@ Helper = {
-- This function must be used close a NFS connection opened
-- by NfsOpen() call
--
-- @param Comm object returned by NfsOpen()
-- @param nfs_comm object returned by NfsOpen()
-- @return true on success or nil on failure
-- @return error message on failure
NfsClose = function(nfs_comm)
@@ -2375,7 +2375,7 @@ Util =
--
-- An optional second argument is the mactime to use
--
-- @param attributes table returned by NFS GETATTR or ACCESS
-- @param attr table returned by NFS GETATTR or ACCESS
-- @param mactime to use, the default value is atime
-- Possible values: mtime, atime, ctime
-- @return String that represent the file attributes

View File

@@ -56,7 +56,7 @@ end
-- @param host table with information as recieved by <code>action</code>
-- @param port table with information as recieved by <code>action</code>
-- @param database string containing the database name
-- @param username string containing the username against which to guess
-- @param creds an iterator producing username, password pairs
-- @param valid_accounts table in which to store found accounts
doLogin = function( host, port, database, creds, valid_accounts )
local helper, status, response, passwords

View File

@@ -15,7 +15,7 @@ SMTP server.
--
-- @args smtp-commands.domain Define the domain to be used in the SMTP commands
--
-- @changelog
-- changelog
-- 1.1.0.0 - 2007-10-12
-- + added HELP command in addition to EHLO
-- 1.2.0.0 - 2008-05-19