Added Lots of Documentation
Added some nice to haves Improved and Unified General Code Layout
This commit is contained in:
@@ -9,14 +9,44 @@
|
||||
#import "MPTerm.h"
|
||||
|
||||
|
||||
/*!
|
||||
@header
|
||||
This file contains the <code>MPVariable</code> class.
|
||||
*/
|
||||
|
||||
|
||||
|
||||
@class MPVariable;
|
||||
|
||||
|
||||
/*!
|
||||
@class MPVariable
|
||||
@abstract This class represents a variable.
|
||||
|
||||
@discussion Variables are evaluated in the <code>@link
|
||||
//apple_ref/occ/cl/MPEvaluationContext@/link</code> and generate
|
||||
errors if they are not defined.
|
||||
*/
|
||||
@interface MPVariable : MPTerm
|
||||
|
||||
/*!
|
||||
@method initWithVariableName:
|
||||
@abstract Initializes a <code>MPVariable</code> with the specified
|
||||
<code>variableName</code>
|
||||
|
||||
@param variableName
|
||||
The name of the variable. Must not be <code>nil</code> and must
|
||||
be at least one character long.
|
||||
|
||||
@return A new <code>MPVariable</code> instance.
|
||||
*/
|
||||
- (instancetype)initWithVariableName:(NSString *)variableName; /* designated initializer */
|
||||
|
||||
|
||||
/*!
|
||||
@property variableName
|
||||
@abstract The receiver's variable name.
|
||||
*/
|
||||
@property (readonly, nonatomic, strong) NSString *variableName;
|
||||
|
||||
@end
|
||||
|
||||
Reference in New Issue
Block a user