diff --git a/docs/scripting.xml b/docs/scripting.xml index 52fe18b7d..3e504fe7c 100644 --- a/docs/scripting.xml +++ b/docs/scripting.xml @@ -798,7 +798,7 @@ action refer to . This section lists (alphabetically) all NSE scripts packaged with Nmap at the time of this writing. It comes straight from the script source code thanks to the NSEDoc documentation system - described in . Of course no + described in . Of course no paper documentation can stay current with software developed as actively as NSE is. For the most comprehensive and up-to-date documentation, see the online NSE Documentation Portal at @@ -1799,7 +1799,7 @@ local localip, localport = try(client_service:get_info()) Writing Script Documentation (NSEDoc) - Nmap Scripting Engine (NSE)documentation in + Nmap Scripting Engine (NSE)documentation in NSEDoc @@ -1819,7 +1819,7 @@ local localip, localport = try(client_service:get_info()) The documentation for scripts and modules is contained in their source code, as comments with a special form. - + is an NSEDoc comment taken from the stdnse.print_debug() function. @@ -1827,7 +1827,7 @@ local localip, localport = try(client_service:get_info()) - + An NSEDoc comment for a function --- Prints a formatted debug message if the current verbosity level is greater @@ -1853,7 +1853,7 @@ local localip, localport = try(client_service:get_info()) other parts of the documentation. In the above example you see @param, which is used to describe each parameter of a function. A complete list of the documentation tags is found - in . + in . @@ -1874,12 +1874,12 @@ local localip, localport = try(client_service:get_info()) and should be several paragraphs long, with all the high-level information useful to a developer using a module or a user running a script. - + shows documentation for the comm module (with a few paragraphs removed to save space). - + An NSEDoc comment for a module --- Common communication functions for network discovery tasks like @@ -1911,13 +1911,13 @@ local localip, localport = try(client_service:get_info()) NSEDoc knows about these variables and will use them in preference to fields in the comments. Scripts should also have an @output tag showing sample output, as well as @args and @usage where appropriate. - + shows proper form for script-level documentation, using a combination of documentation comments and NSE variables. - + An NSEDoc comment for a script description = [[ @@ -1965,7 +1965,7 @@ categories = {"discovery", "external"} documentation in the Nmap source distribution (including nmap.luadoc, bit.luadoc, and pcre.luadoc). - + NSE Documentation Tags The following tags are understood by NSEDoc: @@ -2090,7 +2090,7 @@ categories = {"discovery", "external"} from the contents of a comment. @release has not been used with NSEDoc. --> - +