Added/Corrected Documentation
This commit is contained in:
@@ -8,6 +8,8 @@
|
||||
|
||||
#import "MPExpression.h"
|
||||
|
||||
|
||||
|
||||
/// Convenience Constructor Macro
|
||||
#define MPMakeRangePath(loc, len) [MPRangePath rangePathWithLocation:(loc) length:(len)]
|
||||
|
||||
@@ -50,7 +52,7 @@
|
||||
|
||||
/*!
|
||||
@method initWithRange:
|
||||
@brief Initializes a newly created range path with the given range.
|
||||
@brief Initializes a newly created range path with the specified range.
|
||||
|
||||
@discussion This method is a convenience initializer to convert from a @c
|
||||
NSRange to a @c MPRangePath. The location of @c aRange is
|
||||
@@ -66,7 +68,7 @@
|
||||
|
||||
/*!
|
||||
@method initWithLocation:lenght:
|
||||
@brief Initializes a newly created range path with the given location
|
||||
@brief Initializes a newly created range path with the specified location
|
||||
and length.
|
||||
|
||||
@discussion The last index in the @c location should address the first item
|
||||
@@ -100,7 +102,7 @@
|
||||
/*!
|
||||
@method rangePathWithRange:
|
||||
@brief Allocates a new @c MPRangePath instance and initializes it with
|
||||
the given location and length.
|
||||
the specified location and length.
|
||||
|
||||
@discussion The location of @c aRange is translated into an index path for
|
||||
the range path.
|
||||
@@ -116,7 +118,7 @@
|
||||
/*!
|
||||
@method rangePathWithLocation:length:
|
||||
@brief Allocates a new @c MPRangePath instance and initializes it with
|
||||
the given location and length.
|
||||
the specified location and length.
|
||||
|
||||
@param location
|
||||
The location of the first element that should be addressed by the
|
||||
@@ -254,7 +256,7 @@
|
||||
new exoression. The range path is specified in the length
|
||||
reference frame.
|
||||
|
||||
If the given range exceeds the receiver's bounds a @c
|
||||
If the specified range exceeds the receiver's bounds a @c
|
||||
NSRangeException is raised.
|
||||
|
||||
@param aRangePath
|
||||
|
||||
Reference in New Issue
Block a user