Archived
1

Added Lots of Documentation

Added some nice to haves
Improved and Unified General Code Layout
This commit is contained in:
Kim Wittenburg
2015-01-04 02:54:27 +01:00
parent 152b981e24
commit 7438fd1f95
83 changed files with 2282 additions and 416 deletions

View File

@@ -9,14 +9,44 @@
#import "MPTerm.h"
/*!
@header
This file contains the <code>MPNumber</code> class.
*/
@class MPNumber;
/*!
@class MPNumber
@abstract This class represents a number that evaluates to itself.
@discussion Numbers include integers as well as floating point numbers. They
have to be representable as a decimal number literal (e.g.
<code>3.4</code>). Numbers that have periods or are irrational
are not implemented by this class.
*/
@interface MPNumber : MPTerm
/*!
@method initWithNumber:
@abstract Initializes a number term with the specified <code>number</code>.
@param number
The number that the term should evaluate to. Must not be
<code>nil</code>.
@return A new <code>MPNumberTerm</code> instance.
*/
- (instancetype)initWithNumber:(NSDecimalNumber *)number; /* designated initializer */
/*!
@property number
@abstract The receiver's number.
*/
@property (readonly, nonatomic, strong) NSDecimalNumber *number;
@end