Archived
1

Added Documentation

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

View File

@@ -13,11 +13,44 @@
@class MPSumTerm;
/*!
@class MPSumTerm
@abstract A sum term consists of n terms that are added together.
@discussion Although they are added in order of occurrence the child terms
should be considered having equal priority.
*/
@interface MPSumTerm : MPTerm
/*!
@method initWithSummands:
@abstract Initializes a new sum term with the specified <code>summands</code>.
@discussion There is very little checking performed during initialization.
All objects in the specified array must be valid instances of
subclasses of <code>@link //apple_ref/occ/cl/MPTerm@/link</code>.
The array must contain at least one object.
@param summands
The summands the sum term should be initialized with. The array
must not be <code>nil</code> and must contain at least one
object. The contents of the array are not copied, the array
itself however is.
@return A new sum term.
*/
- (instancetype)initWithSummands:(NSArray *)summands; /* designated initializer */
@property (readonly, nonatomic, strong) NSArray *summands;
/*!
@property summands
@abstract The receiver's summands.
@discussion This property is guaranteed to be non <code>nil</code>. The
contents of the array are specified during initialization of the
receiver.
*/
@property (readonly, nonatomic, copy) NSArray *summands;
@end