1
0
mirror of https://github.com/nmap/nmap.git synced 2025-12-09 14:11:29 +00:00

Fix some @see NSEdoc

https://secwiki.org/w/Nmap/Code_Standards#NSEdoc_best-practices
This commit is contained in:
dmiller
2014-03-04 17:04:58 +00:00
parent 4cef3889f1
commit e296cdea2a
4 changed files with 12 additions and 10 deletions

View File

@@ -104,7 +104,8 @@ local table = require "table"
_ENV = stdnse.module("creds", stdnse.seeall)
-- Table containing the different account states
--- Table mapping the different account states to their number
-- @class table
State = {
LOCKED = 1,
VALID = 2,
@@ -260,6 +261,7 @@ Credentials = {
--- Returns a credential iterator
--
-- @see State
-- @param state mask containing values from the <Code>State</code> table
-- @return credential iterator, returning a credential each time it's
-- called. Unless filtered by the state mask all credentials
@@ -269,7 +271,7 @@ Credentials = {
-- <code>port</code> - number containing the port number
-- <code>user</code> - string containing the user name
-- <code>pass</code> - string containing the user password
-- <code>state</code> - a state number @see <code>State</code>
-- <code>state</code> - a state number
-- <code>service</code> - string containing the name of the service
-- <code>scriptname</code> - string containing the name of the
-- script that added the credential

View File

@@ -41,7 +41,8 @@ ERRORS = {
LDAP_SIZELIMIT_EXCEEDED = 4
}
-- Application constants
--- Application constants
-- @class table
APPNO = {
BindRequest = 0,
BindResponse = 1,
@@ -192,7 +193,8 @@ end
-- Encodes an LDAP Application operation and its data as a sequence
--
-- @param appno LDAP application number @see <code>APPNO</code>
-- @param appno LDAP application number
-- @see APPNO
-- @param isConstructed boolean true if constructed, false if primitive
-- @param data string containing the LDAP operation content
-- @return string containing the encoded LDAP operation

View File

@@ -945,7 +945,6 @@ Mount = {
end
end
---
-- Decode directory entries
--
-- [entry]
@@ -953,14 +952,13 @@ Mount = {
-- [Directory]
-- 4 bytes - value len
-- len bytes - directory name
-- ? bytes - fill bytes (@see calcFillByte)
-- ? bytes - fill bytes (see calcFillByte)
-- [Groups]
-- 4 bytes - value follows (1 if more data, 0 if not)
-- [Group] (1 or more)
-- 4 bytes - group len
-- len bytes - group value
-- ? bytes - fill bytes (@see calcFillByte)
---
-- ? bytes - fill bytes (see calcFillByte)
while true do
-- make sure we have atleast 4 more bytes to check for value follows
status, data = comm:GetAdditionalBytes( data, pos, 4 )

View File

@@ -5,7 +5,7 @@
--
-- The <code>DigestMD5</code> class contains all code necessary to calculate
-- a DIGEST-MD5 response based on the servers challenge and the other
-- necessary arguments (@see DigestMD5.new).
-- necessary arguments.
-- It can be called through the SASL helper or directly like this:
-- <code>
-- local dmd5 = DigestMD5:new(chall, user, pass, "AUTHENTICATE", nil, "imap")
@@ -14,7 +14,7 @@
--
-- The <code>NTLM</code> class contains all code necessary to calculate a
-- NTLM response based on the servers challenge and the other necessary
-- arguments (@see NTLM.new). It can be called through the SASL helper or
-- arguments. It can be called through the SASL helper or
-- directly like this:
-- <code>
-- local ntlm = NTLM:new(chall, user, pass)