Skip to content

Commit 280ccc4

Browse files
eskrocheskroch
committed
Documentation updates.
1 parent 17343e7 commit 280ccc4

156 files changed

Lines changed: 5084 additions & 4106 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎framework/MacOnly/CPTDecimalNumberValueTransformer.m‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,29 @@
22
#import "NSNumberExtensions.h"
33

44
/**
5-
* @brief A Cocoa Bindings value transformer for NSDecimalNumber objects.
5+
* @brief A Cocoa Bindings value transformer for NSDecimalNumber objects.
66
**/
77
@implementation CPTDecimalNumberValueTransformer
88

99
/**
10-
* @brief Indicates that the receiver can reverse a transformation.
11-
* @return YES, the transformation is reversible.
10+
* @brief Indicates that the receiver can reverse a transformation.
11+
* @return @YES, the transformation is reversible.
1212
**/
1313
+(BOOL)allowsReverseTransformation
1414
{
1515
return YES;
1616
}
1717

1818
/**
19-
* @brief The class of the value returned for a forward transformation.
20-
* @return Transformed values will be instances of NSNumber.
19+
* @brief The class of the value returned for a forward transformation.
20+
* @return Transformed values will be instances of NSNumber.
2121
**/
2222
+(Class)transformedValueClass
2323
{
2424
return [NSNumber class];
2525
}
2626

27-
/// @cond
27+
/// @cond
2828

2929
-(id)transformedValue:(id)value
3030
{
@@ -36,6 +36,6 @@ -(id)reverseTransformedValue:(id)value
3636
return [value decimalNumber];
3737
}
3838

39-
/// @endcond
39+
/// @endcond
4040

4141
@end

‎framework/MacOnly/CPTGraphHostingView.m‎

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
#import "CPTGraph.h"
44

5-
/// @cond
5+
/// @cond
66
// for MacOS 10.6 SDK compatibility
77
#if TARGET_IPHONE_SIMULATOR || TARGET_OS_IPHONE
88
#else
@@ -15,26 +15,26 @@ @interface NSWindow(CPTExtensions)
1515
#endif
1616
#endif
1717

18-
/// @endcond
18+
/// @endcond
1919

2020
#pragma mark -
2121

2222
/**
23-
* @brief A container view for displaying a CPTGraph.
23+
* @brief A container view for displaying a CPTGraph.
2424
**/
2525
@implementation CPTGraphHostingView
2626

27-
/** @property hostedGraph
28-
* @brief The CPTGraph hosted inside this view.
27+
/** @property CPTGraph *hostedGraph
28+
* @brief The CPTGraph hosted inside this view.
2929
**/
3030
@synthesize hostedGraph;
3131

32-
/** @property printRect
33-
* @brief The bounding rectangle used when printing this view.
32+
/** @property NSRect printRect
33+
* @brief The bounding rectangle used when printing this view.
3434
**/
3535
@synthesize printRect;
3636

37-
/// @cond
37+
/// @cond
3838

3939
-(id)initWithFrame:(NSRect)frame
4040
{
@@ -48,17 +48,19 @@ -(id)initWithFrame:(NSRect)frame
4848
return self;
4949
}
5050

51-
/// @endcond
52-
5351
-(void)dealloc
5452
{
5553
[hostedGraph removeFromSuperlayer];
5654
[hostedGraph release];
5755
[super dealloc];
5856
}
5957

58+
/// @endcond
59+
6060
#pragma mark -
61-
#pragma mark NSCoding methods
61+
#pragma mark NSCoding Methods
62+
63+
/// @cond
6264

6365
-(void)encodeWithCoder:(NSCoder *)coder
6466
{
@@ -82,10 +84,12 @@ -(id)initWithCoder:(NSCoder *)coder
8284
return self;
8385
}
8486

87+
/// @endcond
88+
8589
#pragma mark -
8690
#pragma mark Drawing
8791

88-
/// @cond
92+
/// @cond
8993

9094
-(void)drawRect:(NSRect)dirtyRect
9195
{
@@ -145,12 +149,12 @@ -(NSRect)rectForPage:(NSInteger)pageNumber
145149
return self.printRect;
146150
}
147151

148-
/// @endcond
152+
/// @endcond
149153

150154
#pragma mark -
151155
#pragma mark Mouse handling
152156

153-
/// @cond
157+
/// @cond
154158

155159
-(BOOL)acceptsFirstMouse:(NSEvent *)theEvent
156160
{
@@ -190,12 +194,12 @@ -(void)mouseUp:(NSEvent *)theEvent
190194
}
191195
}
192196

193-
/// @endcond
197+
/// @endcond
194198

195199
#pragma mark -
196200
#pragma mark Accessors
197201

198-
/// @cond
202+
/// @cond
199203

200204
-(void)setHostedGraph:(CPTGraph *)newGraph
201205
{
@@ -225,6 +229,6 @@ -(void)setHostedGraph:(CPTGraph *)newGraph
225229
}
226230
}
227231

228-
/// @endcond
232+
/// @endcond
229233

230234
@end

‎framework/MacOnly/CPTPlatformSpecificCategories.h‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@
44
#import <AppKit/AppKit.h>
55
#import <QuartzCore/QuartzCore.h>
66

7-
/** @category CPTLayer(CPTPlatformSpecificLayerExtensions)
8-
* @brief Platform-specific extensions to CPTLayer.
7+
/** @category CPTLayer(CPTPlatformSpecificLayerExtensions)
8+
* @brief Platform-specific extensions to CPTLayer.
99
**/
1010
@interface CPTLayer(CPTPlatformSpecificLayerExtensions)
1111

1212
/// @name Images
1313
/// @{
1414
-(CPTNativeImage *)imageOfLayer;
15-
/// @}
15+
/// @}
1616

1717
@end
1818

19-
/** @category CPTColor(CPTPlatformSpecificColorExtensions)
20-
* @brief Platform-specific extensions to CPTColor.
19+
/** @category CPTColor(CPTPlatformSpecificColorExtensions)
20+
* @brief Platform-specific extensions to CPTColor.
2121
**/
2222
@interface CPTColor(CPTPlatformSpecificColorExtensions)
2323

‎framework/MacOnly/CPTPlatformSpecificCategories.m‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
@implementation CPTLayer(CPTPlatformSpecificLayerExtensions)
77

8-
/** @brief Gets an image of the layer contents.
9-
* @return A native image representation of the layer content.
8+
/** @brief Gets an image of the layer contents.
9+
* @return A native image representation of the layer content.
1010
**/
1111
-(CPTNativeImage *)imageOfLayer
1212
{
@@ -35,8 +35,8 @@ -(CPTNativeImage *)imageOfLayer
3535

3636
@implementation CPTColor(CPTPlatformSpecificColorExtensions)
3737

38-
/** @property nsColor
39-
* @brief Gets the color value as an NSColor.
38+
/** @property nsColor
39+
* @brief Gets the color value as an NSColor.
4040
**/
4141
@dynamic nsColor;
4242

‎framework/MacOnly/CPTPlatformSpecificDefines.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#import <AppKit/AppKit.h>
22
#import <Foundation/Foundation.h>
33

4-
/// @file
4+
/// @file
55

66
typedef NSImage CPTNativeImage; ///< Platform-native image format.
77
typedef NSEvent CPTNativeEvent; ///< Platform-native OS event.

‎framework/MacOnly/CPTPlatformSpecificFunctions.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#import <Foundation/Foundation.h>
33
#import <QuartzCore/QuartzCore.h>
44

5-
/// @file
5+
/// @file
66

77
#if __cplusplus
88
extern "C" {
@@ -13,7 +13,7 @@ extern "C" {
1313
void CPTPushCGContext(CGContextRef context);
1414
void CPTPopCGContext(void);
1515

16-
/// @}
16+
/// @}
1717

1818
/// @name Graphics Context
1919
/// @{
@@ -26,7 +26,7 @@ CGContextRef CPTGetCurrentContext(void);
2626
CGColorRef CPTCreateCGColorFromNSColor(NSColor *nsColor);
2727
CPTRGBAColor CPTRGBAColorFromNSColor(NSColor *nsColor);
2828

29-
/// @}
29+
/// @}
3030

3131
#if __cplusplus
3232
}

‎framework/MacOnly/CPTPlatformSpecificFunctions.m‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#import "CPTDefinitions.h"
44
#import "CPTPlatformSpecificDefines.h"
55

6-
/** @brief Node in a linked list of graphics contexts.
6+
/** @brief Node in a linked list of graphics contexts.
77
**/
88
typedef struct _CPTContextNode {
99
NSGraphicsContext *context; ///< The graphics context.
@@ -17,8 +17,8 @@
1717
// linked list to store saved contexts
1818
static CPTContextNode *pushedContexts = NULL;
1919

20-
/** @brief Pushes the current AppKit graphics context onto a stack and replaces it with the given Core Graphics context.
21-
* @param newContext The graphics context.
20+
/** @brief Pushes the current AppKit graphics context onto a stack and replaces it with the given Core Graphics context.
21+
* @param newContext The graphics context.
2222
**/
2323
void CPTPushCGContext(CGContextRef newContext)
2424
{
@@ -32,7 +32,7 @@ void CPTPushCGContext(CGContextRef newContext)
3232
}
3333

3434
/**
35-
* @brief Pops the top context off the stack and restores it to the AppKit graphics context.
35+
* @brief Pops the top context off the stack and restores it to the AppKit graphics context.
3636
**/
3737
void CPTPopCGContext(void)
3838
{
@@ -48,7 +48,7 @@ void CPTPopCGContext(void)
4848
#pragma mark Context
4949

5050
/**
51-
* @brief Get the default graphics context
51+
* @brief Get the default graphics context
5252
**/
5353
CGContextRef CPTGetCurrentContext(void)
5454
{
@@ -58,12 +58,12 @@ CGContextRef CPTGetCurrentContext(void)
5858
#pragma mark -
5959
#pragma mark Colors
6060

61-
/** @brief Creates a CGColorRef from an NSColor.
61+
/** @brief Creates a @ref CGColorRef from an NSColor.
6262
*
63-
* The caller must release the returned CGColorRef. Pattern colors are not supported.
63+
* The caller must release the returned @ref CGColorRef. Pattern colors are not supported.
6464
*
65-
* @param nsColor The NSColor.
66-
* @return The CGColorRef.
65+
* @param nsColor The NSColor.
66+
* @return The @ref CGColorRef.
6767
**/
6868
CGColorRef CPTCreateCGColorFromNSColor(NSColor *nsColor)
6969
{
@@ -74,12 +74,12 @@ CGColorRef CPTCreateCGColorFromNSColor(NSColor *nsColor)
7474
return CGColorCreateGenericRGB(r, g, b, a);
7575
}
7676

77-
/** @brief Creates a CPTRGBAColor from an NSColor.
77+
/** @brief Creates a CPTRGBAColor from an NSColor.
7878
*
79-
* Pattern colors are not supported.
79+
* Pattern colors are not supported.
8080
*
81-
* @param nsColor The NSColor.
82-
* @return The CPTRGBAColor.
81+
* @param nsColor The NSColor.
82+
* @return The CPTRGBAColor.
8383
**/
8484
CPTRGBAColor CPTRGBAColorFromNSColor(NSColor *nsColor)
8585
{

‎framework/MacOnly/CPTTextStylePlatformSpecific.m‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ @implementation NSString(CPTTextStyleExtensions)
99
#pragma mark -
1010
#pragma mark Layout
1111

12-
/** @brief Determines the size of text drawn with the given style.
13-
* @param style The text style.
14-
* @return The size of the text when drawn with the given style.
12+
/** @brief Determines the size of text drawn with the given style.
13+
* @param style The text style.
14+
* @return The size of the text when drawn with the given style.
1515
**/
1616
-(CGSize)sizeWithTextStyle:(CPTTextStyle *)style
1717
{
@@ -40,7 +40,7 @@ -(CGSize)sizeWithTextStyle:(CPTTextStyle *)style
4040

4141
/** @brief Draws the text into the given graphics context using the given style.
4242
* @param rect The bounding rectangle in which to draw the text.
43-
* @param style The text style.
43+
* @param style The text style.
4444
* @param context The graphics context to draw into.
4545
**/
4646
-(void)drawInRect:(CGRect)rect withTextStyle:(CPTTextStyle *)style inContext:(CGContextRef)context

‎framework/Source/CPTAnnotation.h‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,14 @@
2424

2525
#pragma mark -
2626

27-
/** @category CPTAnnotation(AbstractMethods)
28-
* @brief CPTAnnotation abstract methods—must be overridden by subclasses.
27+
/** @category CPTAnnotation(AbstractMethods)
28+
* @brief CPTAnnotation abstract methods—must be overridden by subclasses.
2929
**/
3030
@interface CPTAnnotation(AbstractMethods)
3131

32+
/// @name Layout
33+
/// @{
3234
-(void)positionContentLayer;
35+
/// @}
3336

3437
@end

0 commit comments

Comments
 (0)