1
0
mirror of https://github.com/nmap/nmap.git synced 2026-01-06 06:29:03 +00:00

Fix some NSEDoc errors.

This commit is contained in:
david
2009-01-13 00:18:46 +00:00
parent a384e9016f
commit b504fb78fa
3 changed files with 7 additions and 10 deletions

View File

@@ -158,7 +158,7 @@ end
--- A wrapper around the <code>smb.stop</code> function. I only created it to add symmetry, so client code
-- doesn't have to call both msrpc and smb functions.
--
--@param smbstate The SMB state table.
--@param state The SMB state table.
function stop_smb(state)
smb.stop(state)
end

View File

@@ -792,7 +792,7 @@ end
--- 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.
--
--@param int32 The value of the integer pointer
--@param int64 The value of the integer pointer
--@return A string representing the marshalled data.
function marshall_int64_ptr(int64)
local result
@@ -2503,10 +2503,10 @@ function unmarshall_winreg_StringBuf(data, pos)
return pos, str
end
---Marshall a winreg_StringBuffer pointer. Same as <code>marshall_winreg_StringBuf, except
-- the string can be 'nil'.
---Marshall a winreg_StringBuffer pointer. Same as <code>marshall_winreg_StringBuf</code>, except
-- the string can be <code>nil</code>.
--
--@param str The string to marshall. Can be nil.
--@param table The string to marshall. Can be <code>nil</code>.
--@param max_length [optional] The maximum size of the buffer, in characters. Defaults to the length of the string, including the null.
--@return A string representing the marshalled data.
function marshall_winreg_StringBuf_ptr(table, max_length)
@@ -3099,8 +3099,6 @@ end
-- Not all of them are implemented, however; look at the code to see which are implemented (at the
-- time of this writing, it's 0, 1, and 2).
--
--@param level The level to request. Different levels will return different results, but also require
-- different access levels to call.
--@param data The data being processed.
--@param pos The position within <code>data</code>.
--@return (pos, result) The new position in <code>data</code>, and a table representing the datatype. This may be

View File

@@ -1490,7 +1490,7 @@ function start_session(smb, username, domain, password, password_hash, hash_type
end
--- Sends out SMB_COM_SESSION_TREE_CONNECT_ANDX, which attempts to connect to a share.
--- Sends out <code>SMB_COM_SESSION_TREE_CONNECT_ANDX</code>, which attempts to connect to a share.
-- Sends the following:
-- * Password (for share-level security, which we don't support)
-- * Share name
@@ -1500,7 +1500,7 @@ end
-- * Tree ID
--
--@param smb The SMB object associated with the connection
--@param path The path to connect (eg, "\\servername\C$")
--@param path The path to connect (eg, <code>"\\servername\C$"</code>)
--@return (status, result) If status is false, result is an error message. Otherwise, result is a
-- table with the following elements:
-- * 'tid' The TreeID for the session
@@ -1808,7 +1808,6 @@ end
--@param smb The SMB object associated with the connection
--@param write_data The data to write
--@param offset The offset to write it to (ignored for pipes)
--@param path The path of the file or pipe to open
--@return (status, result) If status is false, result is an error message. Otherwise, result is a table
-- containing a lot of different elements, the most important one being 'fid', the handle to the opened file.
function write_file(smb, write_data, offset)