Skip to content

Commit

Permalink
added periods to comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Terry Worona committed Mar 3, 2014
1 parent fc32f82 commit 47c6d74
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 34 deletions.
28 changes: 14 additions & 14 deletions Classes/JBBarChartView.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
/**
* If showsSelection is YES, a vertical highlight will overlayed on a bar during touch events.
*
* Default: YES
* Default: YES.
*/
@property (nonatomic, assign) BOOL showsSelection;

Expand All @@ -34,8 +34,8 @@
* Height for a bar at a given index (left to right). There is no ceiling on the the height;
* the chart will automatically normalize all values between the overal min and max heights.
*
* @param barChartView The origin chart
* @param index The 0-based index of a given bar (left to right, x-axis)
* @param barChartView The origin chart.
* @param index The 0-based index of a given bar (left to right, x-axis).
*
* @return The y-axis height of the supplied bar index (x-axis)
*/
Expand All @@ -47,17 +47,17 @@
* Occurs when a touch gesture event occurs on a given bar. The chart must be expanded, showsSelection must be YES,
* and the selection must occur within the bounds of the chart.
*
* @param barChartView The origin chart
* @param index The 0-based index of a given bar (left to right, x-axis)
* @param barChartView The origin chart.
* @param index The 0-based index of a given bar (left to right, x-axis).
*/
- (void)barChartView:(JBBarChartView *)barChartView didSelectBarAtIndex:(NSInteger)index;

/**
* Occurs when selection ends by either ending a touch event or selecting an area that is outside the view's bounds.
* For selection start events, see: didSelectBarAtIndex...
*
* @param barChartView The origin chart
* @param index The 0-based index of a given bar. Index will be -1 if the touch ends outside of the view's bounds.
* @param barChartView The origin chart.
* @param index The 0-based index of a given bar. Index will be -1 if the touch ends outside of the view's bounds.
*/
- (void)barChartView:(JBBarChartView *)barChartView didUnselectBarAtIndex:(NSInteger)index;

Expand All @@ -70,7 +70,7 @@
/**
* The number of bars in a given bar chart is the number of vertical views shown along the x-axis.
*
* @param barChartView The origin chart
* @param barChartView The origin chart.
*
* @return Number of bars in the given chart, displayed horizontally along the chart's x-axis.
*/
Expand All @@ -83,7 +83,7 @@
*
* Default: 'best-guess' algorithm based on the the total number of bars and width of the chart.
*
* @param barChartView The origin chart
* @param barChartView The origin chart.
*
* @return Horizontal width (in pixels) between each bar.
*/
Expand All @@ -92,10 +92,10 @@
/**
* A UIView subclass representing the bar at a particular index.
*
* Default: solid black UIView
* Default: solid black UIView.
*
* @param barChartView The origin chart
* @param index The 0-based index of a given bar (left to right, x-axis)
* @param barChartView The origin chart.
* @param index The 0-based index of a given bar (left to right, x-axis).
*
* @return A UIView subclass. The view will automatically be resized by the chart during creation (ie. no need to set the frame).
*/
Expand All @@ -105,9 +105,9 @@
* The selection color to be overlayed on a bar during touch events.
* The color is automically faded to transparent (vertically).
*
* Default: white color (faded to transparent)
* Default: white color (faded to transparent).
*
* @param barChartView The origin chart
* @param barChartView The origin chart.
*
* @return The color to be used on each bar selection.
*/
Expand Down
10 changes: 5 additions & 5 deletions Classes/JBChartView.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ typedef NS_ENUM(NSInteger, JBChartViewState){
@property (nonatomic, strong) UIView *headerView;

/**
* The vertical padding between the header and highest chart point (bar, line, etc)
* The vertical padding between the header and highest chart point (bar, line, etc).
*/
@property (nonatomic, assign) CGFloat headerPadding;

Expand All @@ -51,7 +51,7 @@ typedef NS_ENUM(NSInteger, JBChartViewState){
- (void)reloadData;

/**
* State setter
* State setter.
*
* @param state Either collapse or expanded.
* @param animated Whether or not the state should be animated or not.
Expand All @@ -60,7 +60,7 @@ typedef NS_ENUM(NSInteger, JBChartViewState){
- (void)setState:(JBChartViewState)state animated:(BOOL)animated callback:(void (^)())callback;

/**
* State setter
* State setter.
*
* @param state Either collapse or expanded.
* @param animated Whether or not the state should be animated or not.
Expand All @@ -76,9 +76,9 @@ typedef NS_ENUM(NSInteger, JBChartViewState){
@interface JBChartSelectionView : UIView

/**
* Base selection view color. This color will be faded to transparent vertically
* Base selection view color. This color will be faded to transparent vertically.
*
* Default: white color
* Default: white color.
*
*/
@property (nonatomic, strong) UIColor *bgColor;
Expand Down
30 changes: 15 additions & 15 deletions Classes/JBLineChartView.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
/**
* If showsSelection is YES, a vertical highlight will overlayed on a the line graph during touch events.
*
* Default: YES
* Default: YES.
*/
@property (nonatomic, assign) BOOL showsSelection;

Expand All @@ -33,10 +33,10 @@
* Vertical position for line point at a given index (left to right). There is no ceiling on the the height;
* the chart will automatically normalize all values between the overal min and max heights.
*
* @param lineChartView The origin chart
* @param index The 0-based index of a given line height (left to right, x-axis)
* @param lineChartView The origin chart.
* @param index The 0-based index of a given line height (left to right, x-axis).
*
* @return The y-axis value of the supplied line index (x-axis)
* @return The y-axis value of the supplied line index (x-axis).
*/
- (CGFloat)lineChartView:(JBLineChartView *)lineChartView heightForIndex:(NSInteger)index;

Expand All @@ -46,16 +46,16 @@
* Occurs when a touch gesture event occurs anywhere on the chart. The chart must be expanded, showsSelection must be YES,
* and the selection must occur within the bounds of the chart.
*
* @param lineChartView The origin chart
* @param index The 0-based index of a selection point (left to right, x-axis)
* @param lineChartView The origin chart.
* @param index The 0-based index of a selection point (left to right, x-axis).
*/
- (void)lineChartView:(JBLineChartView *)lineChartView didSelectChartAtIndex:(NSInteger)index;

/**
* Occurs when selection ends by either ending a touch event or selecting an area that is outside the view's bounds.
* For selection start events, see: didSelectChartAtIndex...
*
* @param lineChartView The origin chart
* @param lineChartView The origin chart.
* @param index The 0-based index of a selection point. Index will be -1 if the touch ends outside of the view's bounds.
*/
- (void)lineChartView:(JBLineChartView *)lineChartView didUnselectChartAtIndex:(NSInteger)index;
Expand All @@ -69,7 +69,7 @@
/**
* The number of points in a given line chart equates to the number of values along the x-axis.
*
* @param lineChartView The origin chart
* @param lineChartView The origin chart.
*
* @return Number of points in the given chart.
*/
Expand All @@ -80,20 +80,20 @@
/**
* The color of the line within the chart.
*
* Default: black color
* Default: black color.
*
* @param lineChartView The origin chart
* @param lineChartView The origin chart.
*
* @return The color to be used to draw the line on the chart (alphas < 1 are supported)
* @return The color to be used to draw the line on the chart (alphas < 1 are supported).
*/
- (UIColor *)lineColorForLineChartView:(JBLineChartView *)lineChartView;

/**
* The width of the line within the chart.
*
* Default: 5 points
* Default: 5 points.
*
* @param lineChartView The origin chart
* @param lineChartView The origin chart.
*
* @return The width to be used to draw the line on the chart.
*/
Expand All @@ -103,9 +103,9 @@
* The selection color to be overlayed on the chart during touch events.
* The color is automically faded to transparent (vertically).
*
* Default: white color (faded to transparent)
* Default: white color (faded to transparent).
*
* @param lineChartView The origin chart
* @param lineChartView The origin chart.
*
* @return The color to be used on chart selections.
*/
Expand Down

0 comments on commit 47c6d74

Please sign in to comment.