Fix some nonstandard NSEdoc

nselib/formulas.lua

@@ -133,7 +133,7 @@ end
 --- Return the mean and sample standard deviation of an array, using the
 -- algorithm from Knuth Vol. 2, Section 4.2.2.
 --
--- @params t An array-style table of values
+-- @param t An array-style table of values
 -- @return The mean of the values
 -- @return The standard deviation of the values
 function mean_stddev(t)

nselib/jdwp.lua

@@ -549,9 +549,9 @@ end
 --@param id  Packet id.
 --@param classID Reference type id of the class.
 --@param methodID ID of the static method to call.
---@numberOfArguments Number of method arguments.
+--@param numberOfArguments Number of method arguments.
---@arguments Already packed arguments.
+--@param arguments Already packed arguments.
---@options Invocation options.
+--@param options Invocation options.
 --@return (status, data) If status is false data contains an error string, else it contains a reply data and needs to be parsed manually.
 function invokeStaticMethod(socket,id,classID,methodID,numberOfArguments,arguments,options)
   local params
@@ -582,8 +582,8 @@ end
 --@param classID Reference type id of the class.
 --@param threadID The thread in which to invoke the constructor.
 --@param methodID The constructor to invoke.
---@numberOfArguments Number of constructor arguments.
+--@param numberOfArguments Number of constructor arguments.
---@arguments Already packed arguments.
+--@param arguments Already packed arguments.
 --@return (status, objectID) If status is false data contains an error string, else it contains a reference ID of the newly created object.
 function newClassInstance(socket,id,classID,threadID,methodID,numberOfArguments,arguments)
   local params
@@ -668,7 +668,7 @@ end
 --@param classID The class type.
 --@param methodID ID of the method to invoke.
 --@param numberOfArguments Number of method arguments.
---@arguments Already packed arguments.
+--@param arguments Already packed arguments.
 --@return (status, data) If status is false data contains an error string, else it contains a reply data and needs to be parsed manually.
 function invokeObjectMethod(socket,id,objectID,threadID,classID,methodID,numberOfArguments,arguments)
   local params

nselib/msrpctypes.lua

@@ -303,7 +303,7 @@ end
 --              referent_id was '0', then this function doesn't unmarshall
 --              anything.
 --@return The new position
---@reutrn The result. For HEAD the result is either <code>true</code> for valid
+--@return The result. For HEAD the result is either <code>true</code> for valid
 --        pointers or <code>false</code> for null pointers. For BODY or ALL,
 --        the result is <code>nil</code> for null pointers, or the data for
 --        valid pointers.

scripts/bacnet-info.nse

@@ -61,12 +61,12 @@ categories = {"discovery", "version"}
 
 portrule = shortport.version_port_or_service(47808, "bacnet", {"udp","tcp"})
 
----
+--
 --  Table to look up the Vendor Name based on Vendor ID
 --  Table data from http://www.bacnet.org/VendorID/BACnet%20Vendor%20IDs.htm
 --  Fetched on 9/26/2015
 --
--- @key vennum Vendor number parsed out of the BACNet packet
+-- key is vendor number parsed out of the BACNet packet
 local vendor_id = {
   [0] = "ASHRAE",
   [1] = "NIST",

scripts/enip-info.nse

@@ -63,8 +63,7 @@ portrule = shortport.version_port_or_service(44818, {"EtherNet-IP-2", "EtherNet/
 --  Table data from Wireshark dissector ( link to unofficial mirror )
 --  https://github.com/avsej/wireshark/blob/master/epan/dissectors/packet-enip.c
 --  Fetched on 4/19/2014
-
+-- key is vendor number parsed out of the EtherNet/IP packet
--- @key vennum Vendor number parsed out of the EtherNet/IP packet
 local vendor_id = {
 	[0] = "Reserved",
 	[1] = "Rockwell Automation/Allen-Bradley",
@@ -1573,7 +1572,7 @@ end
 --  https://github.com/avsej/wireshark/blob/master/epan/dissectors/packet-enip.c
 --  Fetched on 4/19/2014
 --
--- @key devtype Device ID  number parsed out of the EtherNet/IP packet
+-- key is Device ID  number parsed out of the EtherNet/IP packet
 local device_type = {
 	[0] = "Generic Device (deprecated)",
 	[1] = "Control Station (deprecated)",

scripts/hartip-info.nse

@@ -64,8 +64,7 @@ portrule = shortport.port_or_service(5094, "hart-ip", "tcp")
 --    Returns "Unknown Device Type" if Expanded Device Type not recognized
 --  Table data from Common Tables Specification, HCF_SPEC-183, FCG TS20183, Revision 26.0
 --  5.1 Table 1. Expanded Device Type Codes
-
+-- key is number-represented Device Type Code parsed out of the HART-IP packet
--- @key expdevtypnum number-represented Device Type Code parsed out of the HART-IP packet
 local productName = {
   [4560] = "iTEMP TMT72",
   [45075] = "GW PL ETH/UNI-BUS",
@@ -80,8 +79,7 @@ end
 --    Returns "Unknown Manufacturer" if Manufacturer ID not recognized
 --  Table data from Common Tables Specification, HCF_SPEC-183, FCG TS20183, Revision 26.0
 --  5.8 Table 8. Manufacturer Identification Codes
-
+-- key is number-represented Manufacturer ID parsed out of the HART-IP packet
--- @key manidnum number-represented Manufacturer ID parsed out of the HART-IP packet
 local manufacturerName = {
   [176] = "Phoenix Contact",
 }

scripts/http-robtex-shared-ns.nse

@@ -15,7 +15,7 @@ The target must be specified by DNS name, not IP address.
 -- @usage
 -- nmap --script http-robtex-shared-ns
 --
--- @outt
+-- @output
 -- Host script results:
 -- | http-robtex-shared-ns:
 -- |   example.edu
@@ -23,7 +23,7 @@ The target must be specified by DNS name, not IP address.
 -- |   example.edu
 -- |_  example.net
 -- (some results omitted for brevity)
---
+
 -- TODO:
 -- * Add list of nameservers, or group output accordingly
 --

scripts/http-vhosts.nse

@@ -40,22 +40,16 @@ various names of the form <name>.example.com are tried.
 -- | www.example.com: 200
 -- | docs.example.com: 302 -> https://www.example.com/docs/
 -- |_images.example.com: 200
---
+
--- @internal: see http://seclists.org/nmap-dev/2010/q4/401 and http://seclists.org/nmap-dev/2010/q4/445
+-- see http://seclists.org/nmap-dev/2010/q4/401 and http://seclists.org/nmap-dev/2010/q4/445
---
+-- todo feature: add option report and implement it
---
+--           after stripping sensitive info like ip, domain names, hostnames
--- @todo feature: add option report and implement it
--- @internal after stripping sensitive info like ip, domain names, hostnames
 --           and redirection targets from the result, append it to a file
 --           that can then be uploaded. If enough info is gathered, the names
 --           will be weighted. It can be shared with metasploit
---
+-- todo feature: fill nsedoc
--- @todo feature: fill nsedoc
+-- todo feature: register results for other scripts (external help needed)
---
+-- todo feature: grow names list (external help needed)
--- @todo feature: register results for other scripts (external help needed)
---
--- @todo feature: grow names list (external help needed)
---
 
 author = "Carlos Pantelides"
 

scripts/lu-enum.nse

@@ -68,8 +68,9 @@ end
 
 --- Compares two screens and returns the difference as a percentage
 --
--- @param1 the original screen
+-- @param the original screen
--- @param2 the screen to compare to
+-- @param the screen to compare to
+-- @return percent difference
 local function screen_diff( orig_screen, current_screen )
   if orig_screen == current_screen then return 100 end
   if #orig_screen == 0 or #current_screen == 0 then return 0 end

scripts/rmi-dumpregistry.nse

@@ -143,9 +143,6 @@ so-called "Custom data".
 -- |         file:/C:/CFusionMX7/runtime/../wwwroot/WEB-INF/cfform/jars/jsse.jar
 -- |         file:/C:/CFusionMX7/runtime/../wwwroot/WEB-INF/cfform/jars/oscache.jar
 -- |_        file:/C:/CFusionMX7/runtime/../wwwroot/WEB-INF/cfform/jars/
---
---
---@version 0.5
 
 author = "Martin Holst Swende"
 license = "Same as Nmap--See https://nmap.org/book/man-legal.html"

scripts/vtam-enum.nse

@@ -81,8 +81,9 @@ end
 
 --- Compares two screens and returns the difference as a percentage
 --
--- @param1 the original screen
+-- @param the original screen
--- @param2 the screen to compare to
+-- @param the screen to compare to
+-- @return percent difference
 local function screen_diff( orig_screen, current_screen )
   if orig_screen == current_screen then return 100 end
   if #orig_screen == 0 or #current_screen == 0 then return 0 end