Added Lots of Documentation
Added some nice to haves Improved and Unified General Code Layout
This commit is contained in:
@@ -7,25 +7,49 @@
|
||||
//
|
||||
|
||||
|
||||
/*!
|
||||
@header
|
||||
This file contains the <code>MPMathRules</code> class.
|
||||
*/
|
||||
|
||||
FOUNDATION_EXPORT NSString *MPMathRulesMaximumOperatorChainLengthKey;
|
||||
FOUNDATION_EXPORT NSString *MPMathRulesMaximumOperatorChainLengthInMultiplicationKey;
|
||||
|
||||
/*!
|
||||
@const MPMathRulesIsUsingDegreesKey
|
||||
@abstract Predefined key that is used to store the properties of the
|
||||
<code>MPMathRules</code> class in the <code>NSUserDefaults</code>
|
||||
database.
|
||||
*/
|
||||
FOUNDATION_EXPORT NSString *MPMathRulesIsUsingDegreesKey;
|
||||
|
||||
|
||||
|
||||
@class MPMathRules;
|
||||
|
||||
|
||||
/*!
|
||||
@class MPMathRules
|
||||
@abstract The math rules class stores global settings concerning
|
||||
mathematical interpretations
|
||||
|
||||
@discussion The <code>MPMathRules</code> class is a singletone class. There
|
||||
can only exist one instance (the shared instance) at any time.
|
||||
*/
|
||||
@interface MPMathRules : NSObject
|
||||
|
||||
/*!
|
||||
@method sharedRules
|
||||
@abstract Returnes the shared <code>MPMathRules</code> instance.
|
||||
*/
|
||||
+ (MPMathRules *)sharedRules;
|
||||
|
||||
@property (nonatomic, getter = isUsingUserDefaultValues) BOOL usingUserDefaultValues;
|
||||
|
||||
// Default value uses the key "..." in NSUserDefaults or ... if the key does not exist.
|
||||
@property (nonatomic) NSUInteger maximumOperatorChainLength; // +--++-5 -> Chain length: 6, 2 default (sign of number and operator) (0 is invalid?)
|
||||
@property (nonatomic) NSUInteger maximumOperatorChainLengthInMultiplication; // Default: 1, 0 means actually 0
|
||||
|
||||
/*!
|
||||
@property isUsingDegrees
|
||||
@abstract Specifies whether trigonometric functions use degree values.
|
||||
|
||||
@discussion If set to <code>NO</code> radians are used instead. The default
|
||||
value is <code>NO</code>.
|
||||
*/
|
||||
@property (nonatomic) BOOL isUsingDegrees;
|
||||
|
||||
@end
|
||||
|
||||
Reference in New Issue
Block a user