Added Lots of Documentation
Added some nice to haves Improved and Unified General Code Layout
This commit is contained in:
@@ -8,11 +8,30 @@
|
||||
|
||||
#import "MPFunctionTerm.h"
|
||||
|
||||
/*!
|
||||
@header
|
||||
This file contains the <code>MPSumFunctionTerm</code> class.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
@class MPSumFunctionTerm;
|
||||
|
||||
|
||||
/*!
|
||||
@class MPSumFunctionTerm
|
||||
@abstract Represents and evaluates a <code>@link
|
||||
//apple_ref/occ/cl/MPSumFunction@/link</code>.
|
||||
|
||||
@discussion A sum function evaluates its sum term <code>n</code> times. How
|
||||
often it actually is evaluated depends on the boundary
|
||||
expressions (start and target). Both are inclusive.
|
||||
|
||||
A sum function also features a variable that contains the current
|
||||
value of the iteration. The variable is defined in the start
|
||||
expression and incremented by <code>1</code> after every
|
||||
iteration.
|
||||
*/
|
||||
@interface MPSumFunctionTerm : MPFunctionTerm
|
||||
|
||||
@end
|
||||
|
||||
Reference in New Issue
Block a user