Gabe Heafitz

Fix comments.

- Make more correct in terms of English grammar and spelling and so
  forth.
- Use commonly-used documentation comment syntax.
... ... @@ -20,9 +20,8 @@ typedef NSString *(^PNyLabelFromatter)(CGFloat yLabelValue);
@interface PNBarChart : UIView
/**
* This method will call and stroke the line in animation
* Draws the chart in an animated fashion.
*/
- (void)strokeChart;
@property (nonatomic) NSArray *xLabels;
... ... @@ -37,98 +36,58 @@ typedef NSString *(^PNyLabelFromatter)(CGFloat yLabelValue);
@property (nonatomic) NSArray *strokeColors;
/*
chartMargin changes chart margin
*/
/** Changes chart margin. */
@property (nonatomic) CGFloat yChartLabelWidth;
/*
yLabelFormatter will format the ylabel text
*/
/** Formats the ylabel text. */
@property (copy) PNyLabelFromatter yLabelFormatter;
/*
chartMargin changes chart margin
*/
@property (nonatomic) CGFloat chartMargin;
/*
showLabelDefines if the Labels should be deplay
*/
/** Controls whether labels should be displayed. */
@property (nonatomic) BOOL showLabel;
/*
showChartBorder if the chart border Line should be deplay
*/
/** Controls whether the chart border line should be displayed. */
@property (nonatomic) BOOL showChartBorder;
/*
chartBottomLine the Line at the chart bottom
*/
/** Chart bottom border, co-linear with the x-axis. */
@property (nonatomic) CAShapeLayer * chartBottomLine;
/*
chartLeftLine the Line at the chart left
*/
/** Chart left border, co-linear with the y-axis. */
@property (nonatomic) CAShapeLayer * chartLeftLine;
/*
barRadius changes the bar corner radius
*/
/** Corner radius for all bars in the chart. */
@property (nonatomic) CGFloat barRadius;
/*
barWidth changes the width of the bar
*/
/** Width of all bars in the chart. */
@property (nonatomic) CGFloat barWidth;
/*
labelMarginTop changes the width of the bar
*/
@property (nonatomic) CGFloat labelMarginTop;
/*
barBackgroundColor changes the bar background color
*/
/** Background color of all bars in the chart. */
@property (nonatomic) UIColor * barBackgroundColor;
/*
labelTextColor changes the bar label text color
*/
/** Text color for all bars in the chart. */
@property (nonatomic) UIColor * labelTextColor;
/*
labelFont changes the bar label font
*/
/** Font for all bars in the chart. */
@property (nonatomic) UIFont * labelFont;
/*
xLabelSkip define the label skip number
*/
/** How many labels on the x-axis to skip in between displaying labels. */
@property (nonatomic) NSInteger xLabelSkip;
/*
yLabelSum define the label sum number
*/
/** How many labels on the y-axis to skip in between displaying labels. */
@property (nonatomic) NSInteger yLabelSum;
/*
yMaxValue define the max value of the chart
*/
/** The maximum for the range of values to display on the y-axis. */
@property (nonatomic) CGFloat yMaxValue;
/*
yMinValue define the min value of the chart
*/
/** The minimum for the range of values to display on the y-axis. */
@property (nonatomic) CGFloat yMinValue;
/*
switch to indicate that the bar should be filled as a gradient
*/
/** Controls whether each bar should have a gradient fill. */
@property (nonatomic) UIColor *barColorGradientStart;
@property (nonatomic, retain) id<PNChartDelegate> delegate;
@end
... ...
... ... @@ -11,20 +11,17 @@
@protocol PNChartDelegate <NSObject>
/**
* When user click on the chart line
*
* Callback method that gets invoked when the user taps on the chart line.
*/
- (void)userClickedOnLinePoint:(CGPoint)point lineIndex:(NSInteger)lineIndex;
/**
* When user click on the chart line key point
*
* Callback method that gets invoked when the user taps on a chart line key point.
*/
- (void)userClickedOnLineKeyPoint:(CGPoint)point lineIndex:(NSInteger)lineIndex andPointIndex:(NSInteger)pointIndex;
/**
* When user click on a chart bar
*
* Callback method that gets invoked when the user taps on a chart bar.
*/
- (void)userClickedOnBarCharIndex:(NSInteger)barIndex;
... ...
... ... @@ -13,9 +13,8 @@
@interface PNLineChart : UIView
/**
* This method will call and troke the line in animation
* Draws the chart in an animated fashion.
*/
- (void)strokeChart;
@property (nonatomic, retain) id<PNChartDelegate> delegate;
... ... @@ -58,7 +57,7 @@
@property (nonatomic) BOOL showLabel;
/**
* show CoordinateAxis ornot, Default is not
* Controls whether to show the coordinate axis. Default is NO.
*/
@property (nonatomic, getter = isShowCoordinateAxis) BOOL showCoordinateAxis;
@property (nonatomic) UIColor *axisColor;
... ... @@ -68,7 +67,7 @@
@property (nonatomic, strong) NSString *yUnit;
/**
* String formatter for float values in y labels. If not set, defaults to @"%1.f"
* String formatter for float values in y-axis labels. If not set, defaults to @"%1.f"
*/
@property (nonatomic, strong) NSString *yLabelFormat;
... ...
... ... @@ -15,11 +15,20 @@
@property (nonatomic, readonly) NSArray *items;
@property (nonatomic) UIFont *descriptionTextFont; //default is [UIFont fontWithName:@"Avenir-Medium" size:18.0];
@property (nonatomic) UIColor *descriptionTextColor; //default is [UIColor whiteColor]
@property (nonatomic) UIColor *descriptionTextShadowColor; //default is [[UIColor blackColor] colorWithAlphaComponent:0.4]
@property (nonatomic) CGSize descriptionTextShadowOffset; //default is CGSizeMake(0, 1)
@property (nonatomic) NSTimeInterval duration;//default is 1.0
/** Default is 18-point Avenir-Medium. */
@property (nonatomic) UIFont *descriptionTextFont;
/** Default is white. */
@property (nonatomic) UIColor *descriptionTextColor;
/** Default is black, with an alpha of 0.4. */
@property (nonatomic) UIColor *descriptionTextShadowColor;
/** Default is CGSizeMake(0, 1). */
@property (nonatomic) CGSize descriptionTextShadowOffset;
/** Default is 1.0. */
@property (nonatomic) NSTimeInterval duration;
- (void)strokeChart;
... ...