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,10 +13,45 @@
@class MPProductTerm;
/*!
@class MPProductTerm
@abstract A product term consists of n terms that are multiplied together.
@discussion Although they are mutliplied in order of occurrence the child
terms should be considered having equal priority.
*/
@interface MPProductTerm : MPTerm
/*!
@method initWithFactors:
@abstract Initializes a new product term with the specified
<code>factors</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 factors
The factors the product 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)initWithFactors:(NSArray *)factors; /* designated initializer */
/*!
@property factors
@abstract The receiver's factors.
@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, strong) NSArray *factors;
@end