Archived
1
This repository has been archived on 2022-08-08. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
mathpad/MathKit/MPMathRules.h
Kim Wittenburg 7438fd1f95 Added Lots of Documentation
Added some nice to haves
Improved and Unified General Code Layout
2015-01-04 02:54:27 +01:00

56 lines
1.3 KiB
Objective-C

//
// MPMathRules.h
// MathPad
//
// Created by Kim Wittenburg on 14.09.14.
// Copyright (c) 2014 Kim Wittenburg. All rights reserved.
//
/*!
@header
This file contains the <code>MPMathRules</code> class.
*/
/*!
@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 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