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

23
MathKit/MPSumFunction.h
View File

@@ -6,13 +6,6 @@
// Copyright (c) 2014 Kim Wittenburg. All rights reserved.
//
/*!
@header
This is a description of the MPFunction class.
It has multiple lines.
*/
#import "MPFunction.h"
@@ -22,7 +15,7 @@
/*!
@class MPSumFunction
@brief This class represents a sum function (generally noted using a
@abstract This class represents a sum function (generally noted using a
capital sigma).
@discussion A sum function has a start and a target expression indicating how
@@ -30,28 +23,26 @@
the start expression and the target expressions are included in
the iterations.
Each iteration the sum value is incremented by @c 1. If the start
and target expression evaluate to the same value the sum is
evaluated once.
Each iteration the sum value is incremented by <code>1</code>. If
the start and target expression evaluate to the same value the
sum is evaluated once.
*/
@interface MPSumFunction : MPFunction
/*!
@property startExpression
@brief The value of the first iteration.
@abstract The value of the first iteration.
@discussion The start expression must define a variable that may be used in
the sum expression. If the start expression does not define a
variable the sum function will fail on validation.
@code Some samples
*/
@property (nonatomic, strong) MPExpression *startExpression; /* Index 0 */
/*!
@property targetExpression
@brief The value if the last iteration.
@abstract The value if the last iteration.
@discussion The target expression must not define a variable.
*/
@@ -60,7 +51,7 @@
/*!
@property sumExpression
@brief The sum expression evaluated multiple times.
@abstract The sum expression evaluated multiple times.
@discussion During evaluation of the sum expression the variable defined in
the start expression is available. That variable always contains