mirror of
https://github.com/nmap/nmap.git
synced 2026-01-01 04:19:02 +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,6 +1,7 @@
|
||||
id = "Daytime"
|
||||
|
||||
description = "Connects to the UDP daytime service and on success prints the daytime."
|
||||
description = [[
|
||||
Retrieves the day and time from the UDP Daytime service.
|
||||
]]
|
||||
|
||||
author = "Diman Todorov <diman.todorov@gmail.com>"
|
||||
|
||||
|
||||
Reference in New Issue
Block a user