From eacb9512099129024dbca5fc6c0ded9424b4a7a2 Mon Sep 17 00:00:00 2001 From: jah Date: Sat, 18 Oct 2008 20:49:00 +0000 Subject: [PATCH] Fixed typos for some nsedoc tag names: INFO processing file `nselib/datafiles.lua' ERROR undefined handler for tag `type' INFO processing file `nselib/dns.lua' ERROR undefined handler for tag `result' ERROR undefined handler for tag `result' INFO processing file `nselib/netbios.lua' ERROR undefined handler for tag `returns' INFO processing file `nselib/snmp.lua' ERROR undefined handler for tag `result' INFO processing file `scripts/SSLv2-support.nse' ERROR undefined handler for tag `ouput' Removed a @see tag which refers to Lua's string.format rather than to NSE docs: INFO generating file `docs/modules/stdnse.html' ERROR unresolved reference to symbol `string.format' --- nselib/datafiles.lua | 2 +- nselib/dns.lua | 4 ++-- nselib/netbios.lua | 2 +- nselib/snmp.lua | 2 +- nselib/stdnse.lua | 1 - scripts/SSLv2-support.nse | 2 +- 6 files changed, 6 insertions(+), 7 deletions(-) diff --git a/nselib/datafiles.lua b/nselib/datafiles.lua index 5601e70eb..7ee4e5bca 100644 --- a/nselib/datafiles.lua +++ b/nselib/datafiles.lua @@ -15,7 +15,7 @@ local stdnse = require "stdnse" --- -- Capture patterns for common data files, indexed by filename. --- @type table +-- @class table -- @name common_files -- @see parse_file local common_files = { diff --git a/nselib/dns.lua b/nselib/dns.lua index cdbf49a26..05583b73e 100644 --- a/nselib/dns.lua +++ b/nselib/dns.lua @@ -636,7 +636,7 @@ end --- -- Decodes DNS flags. --@param Flags as binary digit string. ---@result Table representing flags. +--@return Table representing flags. local function decodeFlags(flgStr) flags = {} flgTbl = str2tbl(flgStr) @@ -659,7 +659,7 @@ end --- -- Decodes a DNS packet. --@param data Encoded DNS packet. ---@result Table representing DNS packet. +--@return Table representing DNS packet. function decode(data) local pos local pkt = {} diff --git a/nselib/netbios.lua b/nselib/netbios.lua index 38828d66a..a150777dd 100644 --- a/nselib/netbios.lua +++ b/nselib/netbios.lua @@ -76,7 +76,7 @@ end -- the string representation. If the encoding is invalid, it will still attempt -- to decode the string as best as possible. --@param encoded_name The L2-encoded name ---@returns the decoded name and the scope. The name will still be padded, and the +--@return the decoded name and the scope. The name will still be padded, and the -- scope will never be nil (empty string is returned if no scope is present) function name_decode(encoded_name) local name = "" diff --git a/nselib/snmp.lua b/nselib/snmp.lua index c2d1a38cc..effd1743a 100644 --- a/nselib/snmp.lua +++ b/nselib/snmp.lua @@ -537,7 +537,7 @@ end --- -- Fetches values from a SNMP response. --@param resp SNMP Response (will be decoded if necessary). ---@result Table with all decoded responses and their OIDs. +--@return Table with all decoded responses and their OIDs. function fetchResponseValues(resp) if (type(resp) == "string") then local _ diff --git a/nselib/stdnse.lua b/nselib/stdnse.lua index 3c5f20525..14f423d5d 100644 --- a/nselib/stdnse.lua +++ b/nselib/stdnse.lua @@ -26,7 +26,6 @@ module(... or "stdnse"); --@param level Optional verbosity level. --@param fmt Format string according to string.format specifiers. --@param ... Arguments to format. ---@see string.format print_debug = function(level, fmt, ...) local verbosity = tonumber(level); if verbosity then diff --git a/scripts/SSLv2-support.nse b/scripts/SSLv2-support.nse index c6c482bb2..fa5572028 100644 --- a/scripts/SSLv2-support.nse +++ b/scripts/SSLv2-support.nse @@ -5,7 +5,7 @@ offers. ]] --- ---@ouput +--@output -- 443/tcp open https syn-ack\n -- | SSLv2: server still supports SSLv2\n -- | SSL2_RC4_128_WITH_MD5\n