mirror of
https://github.com/nmap/nmap.git
synced 2026-01-06 14:39:03 +00:00
Normalize NSEDoc documentation of scripts.
I made every script follow a standard form: it starts with the id, followed by the description. The description is contained in [[ ]] delimiters. The description is in the global description variable, not in a LuaDoc comment. Other LuaDoc information such as @args and @usage follows the description in a comment. The first paragraph of each description is a a short summary of what the script does. More detailed information, if any, is given in following paragraphs. I also improved some wording and formatting in a few cases.
This commit is contained in:
@@ -1,5 +1,7 @@
|
||||
id="SSH Protocol Version 1"
|
||||
description="Checks to see if SSH server supports SSH Protocol Version 1."
|
||||
id = "SSH Protocol Version 1"
|
||||
description = [[
|
||||
Checks if an SSH server supports SSH Protocol Version 1.
|
||||
]]
|
||||
author = "Brandon Enright <bmenrigh@ucsd.edu>"
|
||||
license = "Same as Nmap--See http://nmap.org/book/man-legal.html"
|
||||
categories = {"default", "safe"}
|
||||
|
||||
Reference in New Issue
Block a user