Commit 3059f0ff authored by jhammen's avatar jhammen
Browse files

add docs for regex type

parent d939e064
......@@ -155,6 +155,25 @@ an array is zero-based
</method>
</methods>
</type>
<type name='regex'>
<desc lang="en">represents a regular expression</desc>
<methods>
<method name='match' returns='array'>
<desc lang="en">Returns an array containing the match groups if the entire string
matches this regular expression, otherwise returns null</desc>
<parameters>
<parameter name='string'><desc lang="en"/></parameter>
</parameters>
</method>
<method name='find' returns='array'>
<desc lang="en">Finds instances of this regular expression within the given string and returns an array of the results.
Each result is a table containing two slots: "match" gives the matched substring and "index" gives the integer position of this match within the larger string </desc>
<parameters>
<parameter name='string'><desc lang="en"/></parameter>
</parameters>
</method>
</methods>
</type>
<type name='string'>
<desc lang="en">represents an immutable string</desc>
<methods>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment