1
0
mirror of https://github.com/nmap/nmap.git synced 2025-12-07 21:21:31 +00:00

Fix some NSEDoc. Some libraries had @copyright and @author right at the

top of the first comment, so the entire description got stuffed into the
@author field. I also discovered a limitation in the NSEDoc parser: the
first non-empty line following the first --- comment must be the
"module" call, or else the block isn't recognized as belonging to a
module. This was preventing @args from appearing in certain libraries.
Djalal Harouni told me about this.
This commit is contained in:
david
2010-04-15 19:21:13 +00:00
parent f3a989f989
commit dc03a70c79
4 changed files with 28 additions and 30 deletions

View File

@@ -1,7 +1,5 @@
--- MSSQL Library supporting a very limited subset of operations
-- @copyright Same as Nmap--See http://nmap.org/book/man-legal.html
--
-- @author = "Patrik Karlsson <patrik@cqure.net>"
---
-- MSSQL Library supporting a very limited subset of operations
--
-- Summary
-- -------
@@ -92,21 +90,20 @@
-- o Queries using SELECT, INSERT, DELETE and EXEC of procedures have been
-- tested while developing scripts.
--
-- @copyright Same as Nmap--See http://nmap.org/book/man-legal.html
--
-- @author "Patrik Karlsson <patrik@cqure.net>"
--
-- @args mssql.timeout How long to wait for SQL responses. This is a number
-- followed by <code>ms</code> for milliseconds, <code>s</code> for seconds,
-- <code>m</code> for minutes, or <code>h</code> for hours. Default:
-- <code>30s</code>.
--
module(... or "mssql", package.seeall)
-- Version 0.2
-- Created 01/17/2010 - v0.1 - created by Patrik Karlsson <patrik@cqure.net>
-- Revised 03/28/2010 - v0.2 - fixed incorrect token types. added 30 seconds timeout
--
--
module(... or "mssql", package.seeall)
require("bit")
require("bin")

View File

@@ -1,18 +1,18 @@
--- Simple MySQL Library supporting a very limited subset of operations
---
-- Simple MySQL Library supporting a very limited subset of operations
-- http://forge.mysql.com/wiki/MySQL_Internals_ClientServer_Protocol
--
-- @copyright Same as Nmap--See http://nmap.org/book/man-legal.html
--
--
-- @author = "Patrik Karlsson <patrik@cqure.net>"
--
-- @author "Patrik Karlsson <patrik@cqure.net>"
module(... or "mysql", package.seeall)
-- Version 0.2
--
-- Created 01/15/2010 - v0.1 - created by Patrik Karlsson <patrik@cqure.net>
-- Revised 01/23/2010 - v0.2 - added query support, cleanup, documentation
-- http://forge.mysql.com/wiki/MySQL_Internals_ClientServer_Protocol
module(... or "mysql", package.seeall)
local HAVE_SSL = false
if pcall(require,'openssl') then

View File

@@ -1,7 +1,4 @@
---
-- @copyright Same as Nmap--See http://nmap.org/book/man-legal.html
-- @author = "Patrik Karlsson <patrik@cqure.net>"
--
-- PostgreSQL library supporting both version 2 and version 3 of the protocol
-- The library currently contains the bare minimum to perform authentication
-- Authentication is supported with or without SSL enabled and using the
@@ -12,14 +9,17 @@
-- ref: http://developer.postgresql.org/pgdocs/postgres/protocol-flow.html
-- ref: http://developer.postgresql.org/pgdocs/postgres/protocol-message-formats.html
--
-- @copyright Same as Nmap--See http://nmap.org/book/man-legal.html
-- @author "Patrik Karlsson <patrik@cqure.net>"
module(... or "pgsql",package.seeall)
-- Version 0.3
-- Created 02/05/2010 - v0.1 - created by Patrik Karlsson <patrik@cqure.net>
-- Revised 02/20/2010 - v0.2 - added detectVersion to automaticaly detect and return
-- the correct version class
-- Revised 03/04/2010 - v0.3 - added support for trust authentication method
module(... or "pgsql",package.seeall)
require("openssl")
require("bit")

View File

@@ -1,7 +1,5 @@
--- RPC Library supporting a very limited subset of operations
-- @copyright Same as Nmap--See http://nmap.org/book/man-legal.html
--
-- @author = "Patrik Karlsson <patrik@cqure.net>"
---
-- RPC Library supporting a very limited subset of operations
--
-- Summary
-- -------
@@ -77,12 +75,18 @@
-- When multiple versions exists for a specific RPC program the library
-- always attempts to connect using the highest available version.
--
-- @copyright Same as Nmap--See http://nmap.org/book/man-legal.html
--
-- @author "Patrik Karlsson <patrik@cqure.net>"
--
-- @args nfs.version number If set overrides the detected version of nfs
-- @args mount.version number If set overrides the detected version of mountd
-- @args rpc.protocol table If set overrides the preferred order in which
-- protocols are tested. (ie. "tcp", "udp")
--
module(... or "rpc", package.seeall)
require("datafiles")
-- Version 0.3
--
-- Created 01/24/2010 - v0.1 - created by Patrik Karlsson <patrik@cqure.net>
@@ -91,9 +95,6 @@
-- Revised 03/13/2010 - v0.3 - re-worked library to be OO
--
module(... or "rpc", package.seeall)
require("datafiles")
-- Defines the order in which to try to connect to the RPC programs
-- TCP appears to be more stable than UDP in most cases, so try it first