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

Add some missing NSEdoc params to re.lua

This commit is contained in:
dmiller
2014-07-31 19:18:04 +00:00
parent 7eb678a893
commit b7485a6e7f

View File

@@ -13,8 +13,8 @@
-- defs table provides extra Lua values to be used by the pattern. -- defs table provides extra Lua values to be used by the pattern.
-- @class function -- @class function
-- @name compile -- @name compile
-- @param string -- @param string a regular expression or an LPeg grammar
-- @param defs Optional -- @param defs Optional values to be used by the pattern
-- @return an LPeg pattern -- @return an LPeg pattern
--- Searches the given pattern in the given subject. --- Searches the given pattern in the given subject.
@@ -27,9 +27,9 @@
-- from the end. -- from the end.
-- @class function -- @class function
-- @name find -- @name find
-- @param subject -- @param subject The string to search
-- @param pattern -- @param pattern A regular expression
-- @param init Optional -- @param init Optional index into subject to start searching
-- @return index where the occurrence starts or nil -- @return index where the occurrence starts or nil
-- @return index where the occurrence ends -- @return index where the occurrence ends
@@ -39,19 +39,19 @@
-- given subject by replacement. -- given subject by replacement.
-- @class function -- @class function
-- @name gsub -- @name gsub
-- @param subject -- @param subject The string to search
-- @param pattern -- @param pattern The pattern to match
-- @param replacement -- @param replacement The replacement for each pattern
-- @return index where occurrence starts or pattern captures -- @return The string with all occurrences replaced
--- Matches the given pattern against the given subject --- Matches the given pattern against the given subject
-- --
-- Matches the given pattern against the given subject, returning all captures. -- Matches the given pattern against the given subject, returning all captures.
-- @class function -- @class function
-- @name match -- @name match
-- @param subject -- @param subject The string to search
-- @param pattern -- @param pattern The pattern to match
-- @param init Optional -- @param init Optional index into subject to start searching
-- @return pattern captures -- @return pattern captures
--- Updates the pre-defined character classes to the current locale. --- Updates the pre-defined character classes to the current locale.