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

20
MathKit/MPExpressionTokenizer.h
View File

@@ -13,24 +13,28 @@
/*!
@class MPExpressionTokenizer
@brief The expression tokenizer class convers an @c MPExpression
instance into an array of tokens.
@abstract The expression tokenizer class convers an <code>@link
MPExpression@/link</code> instance into an array of tokens.
*/
@interface MPExpressionTokenizer : NSObject
/*!
@method tokenizeExpression:
@brief Converts an @c MPExpression instance into an array of tokens.
@abstract Converts an <code>@link MPExpression@/link</code> 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.
@discussion The objects in the returned array all conform to the <code>@link
//apple_ref/occ/intf/MPToken@/link</code> protocol. Function
tokens are not copied from the <code>expression</code> so they
can still be mutated.
This method can be safely called from multiple threads.
@param expression
The expression to be tokenized.
@return An array of objects that conform to the @c MPToken protocol.
@return An array of objects that conform to the <code>@link
//apple_ref/occ/intf/MPToken@/link</code> protocol.
*/
+ (NSArray *)tokenizeExpression:(MPExpression *)expression;