codello/mathpad
Archived
1
Fork 0
Code Releases 1 Activity

Added Documentation

Browse Source
This commit is contained in:
Kim Wittenburg
2014-12-17 22:04:49 +01:00
parent 8f1f730358
commit 7f6ee6e118
31 changed files with 1141 additions and 533 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
MathKit/NSRegularExpression+MPParsingAdditions.h
View File

@@ -8,16 +8,21 @@
/*!
@category NSRegularExpression (MPParsingAdditions)
@abstract This category adds convenience methods for typical calls to
<code>firstMatchInString:options:range:</code>.
*/
@interface NSRegularExpression (MPParsingAdditions)
/*!
@method firstMathInString:
@brief Returns the first match of the regular expression within the
@abstract Returns the first match of the regular expression within the
specified string.
@discussion This is a convenience method that calls @c
-firstMatchInString:options:range:
@discussion This is a convenience method that calls
<code>firstMatchInString:options:range:</code>.
@param string
The string to search.
@@ -25,19 +30,19 @@
@return An NSTextCheckingResult object. This result gives the overall
matched range via its range property, and the range of each
individual capture group via its rangeAtIndex: method. The range
@c {NSNotFound, 0} is returned if one of the capture groups did
not participate in this particular match.
<code>{NSNotFound, 0}</code> is returned if one of the capture
groups did not participate in this particular match.
*/
- (NSTextCheckingResult *)firstMatchInString:(NSString *)string;
/*!
@method firstMathInString:fromIndex
@brief Returns the first match of the regular expression from the
@abstract Returns the first match of the regular expression from the
specified index in the string.
@discussion This is a convenience method that calls @c
-firstMatchInString:options:range:
@discussion This is a convenience method that calls
<code>firstMatchInString:options:range:</code>.
@param string
The string to search.
@@ -48,50 +53,50 @@
@return An NSTextCheckingResult object. This result gives the overall
matched range via its range property, and the range of each
individual capture group via its rangeAtIndex: method. The range
@c {NSNotFound, 0} is returned if one of the capture groups did
not participate in this particular match.
<code>{NSNotFound,</code> 0} is returned if one of the capture
groups did not participate in this particular match.
*/
- (NSTextCheckingResult *)firstMatchInString:(NSString *)string fromIndex:(NSUInteger)start;
/*!
@method firstMathInString:options:
@brief Returns the first match of the regular expression within the
@abstract Returns the first match of the regular expression within the
specified string.
@discussion This is a convenience method that calls @c
-firstMatchInString:options:range:
@discussion This is a convenience method that calls
<code>firstMatchInString:options:range:</code>.
@param string
The string to search.
@param options
The matching options to use. See @c NSMatchingOptions for
possible values.
The matching options to use. See <code>NSMatchingOptions</code>
for possible values.
@return An NSTextCheckingResult object. This result gives the overall
matched range via its range property, and the range of each
individual capture group via its rangeAtIndex: method. The range
@c {NSNotFound, 0} is returned if one of the capture groups did
not participate in this particular match.
<code>{NSNotFound,</code> 0} is returned if one of the capture
groups did not participate in this particular match.
*/
- (NSTextCheckingResult *)firstMatchInString:(NSString *)string options:(NSMatchingOptions)options;
/*!
@method firstMathInString:fromIndex
@brief Returns the first match of the regular expression from the
@method firstMathInString:options:fromIndex
@abstract Returns the first match of the regular expression from the
specified index in the string.
@discussion This is a convenience method that calls @c
-firstMatchInString:options:range:
@discussion This is a convenience method that calls
<code>firstMatchInString:options:range:</code>.
@param string
The string to search.
@param options
The matching options to use. See @c NSMatchingOptions for
possible values.
The matching options to use. See <code>NSMatchingOptions</code>
for possible values.
@param start
The index from which to start searching.
@@ -99,8 +104,8 @@
@return An NSTextCheckingResult object. This result gives the overall
matched range via its range property, and the range of each
individual capture group via its rangeAtIndex: method. The range
@c {NSNotFound, 0} is returned if one of the capture groups did
not participate in this particular match.
<code>{NSNotFound,</code> 0} is returned if one of the capture
groups did not participate in this particular match.
*/
- (NSTextCheckingResult *)firstMatchInString:(NSString *)string options:(NSMatchingOptions)options fromIndex:(NSUInteger)start;