Added Documentation
This commit is contained in:
@@ -6,10 +6,32 @@
|
||||
// Copyright (c) 2014 Kim Wittenburg. All rights reserved.
|
||||
//
|
||||
|
||||
|
||||
|
||||
@class MPExpressionTokenizer, MPExpression;
|
||||
|
||||
|
||||
/*!
|
||||
@class MPExpressionTokenizer
|
||||
@brief The expression tokenizer class convers an @c MPExpression
|
||||
instance into an array of tokens.
|
||||
*/
|
||||
@interface MPExpressionTokenizer : NSObject
|
||||
|
||||
|
||||
/*!
|
||||
@method tokenizeExpression:
|
||||
@brief Converts an @c MPExpression instance into an array of tokens.
|
||||
|
||||
@discussion The objects in the returned array all conform to the @c MPToken
|
||||
protocol. Function tokens are not copied from the @c expression
|
||||
so they can still be mutated.
|
||||
|
||||
@param expression
|
||||
The expression to be tokenized.
|
||||
|
||||
@return An array of objects that conform to the @c MPToken protocol.
|
||||
*/
|
||||
+ (NSArray *)tokenizeExpression:(MPExpression *)expression; // Returns MPToken's
|
||||
|
||||
@end
|
||||
|
||||
Reference in New Issue
Block a user