Archived
1

Added Documentation

This commit is contained in:
Kim Wittenburg
2014-11-10 21:45:50 +01:00
parent f4f924bd71
commit 10f0e73ad3
32 changed files with 1847 additions and 318 deletions

View File

@@ -8,11 +8,37 @@
#import "MPFunction.h"
@class MPSuffixFunction;
@protocol MPValue;
/*!
@class MPSuffixFunction
@brief This is the common superclass for all functions that apply to the
value preceeding them.
@discussion One example for a suffix function is a power. Powers apply to a
base value and are evaluated with very high priority. In fact the
base value may not be used without previously having evaluated
the suffix function.
Another special thing about suffix functions is that they need to
know more than their own children (namely the base value) to be
evaluated. To be able to do this suffix functions have a special
property @c baseValue that is set before the function is
evaluated.
*/
@interface MPSuffixFunction : MPFunction
/*!
@property baseValue
@brief The receiver's base value.
@discussion The base value is the thing a suffix function applies to (e.g.
a power's base).
*/
@property (nonatomic, strong) id<MPValue> baseValue;
@end