Skip to content

Commit fb9b284

Browse files
hydrogen-mvmHeadline
authored andcommitted
Correct malformed Regex documentation (#1055)
1 parent 5868ffd commit fb9b284

1 file changed

Lines changed: 2 additions & 5 deletions

File tree

plugins/include/regex.inc

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,6 @@ methodmap Regex < Handle
126126
// Matches a string against a pre-compiled regular expression pattern.
127127
//
128128
// @param str The string to check.
129-
// @param regex Regex Handle from CompileRegex()
130129
// @param ret Error code, if applicable.
131130
// @param offset Offset in the string to start searching from. MatchOffset returns the offset of the match.
132131
// @return Number of captures found or -1 on failure.
@@ -138,19 +137,17 @@ methodmap Regex < Handle
138137
// Gets all matches from a string against a pre-compiled regular expression pattern.
139138
//
140139
// @param str The string to check.
141-
// @param regex Regex Handle from CompileRegex()
142140
// @param ret Error code, if applicable.
143141
// @return Number of matches found or -1 on failure.
144142
//
145143
// @note Use GetSubString() and loop from 0 -> totalmatches - 1.
146144
public native int MatchAll(const char[] str, RegexError &ret = REGEX_ERROR_NONE);
147145

148146
// Returns a matched substring from a regex handle.
149-
//
147+
//
150148
// Substring ids start at 0 and end at captures-1, where captures is the
151149
// number returned by Regex.Match or Regex.CaptureCount.
152150
//
153-
// @param regex The regex handle to extract data from.
154151
// @param str_id The index of the expression to get - starts at 0, and ends at captures - 1.
155152
// @param buffer The buffer to set to the matching substring.
156153
// @param maxlen The maximum string length of the buffer.
@@ -199,8 +196,8 @@ native Regex CompileRegex(const char[] pattern, int flags = 0, char[] error="",
199196
/**
200197
* Matches a string against a pre-compiled regular expression pattern.
201198
*
202-
* @param str The string to check.
203199
* @param regex Regex Handle from CompileRegex()
200+
* @param str The string to check.
204201
* @param ret Error code, if applicable.
205202
* @return Number of captures found or -1 on failure.
206203
*

0 commit comments

Comments
 (0)