Skip to content

Commit

Permalink
Updated .h documentation to reflect new keys
Browse files Browse the repository at this point in the history
  • Loading branch information
bennyguitar committed Feb 20, 2014
1 parent 927653d commit ae10e59
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions Colours.h
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ typedef NS_ENUM(NSInteger, ColorFormulation) {

/**
Creates a Color from a dictionary of 4 NSNumbers
Keys: @"r",@"g",@"b",@"a"
Keys: kColoursRGBA_R, kColoursRGBA_G, kColoursRGBA_B, kColoursRGBA_A
@param rgbaDictionary 4 NSNumbers for rgba between 0 - 1
@return Color
*/
Expand All @@ -98,7 +98,7 @@ typedef NS_ENUM(NSInteger, ColorFormulation) {

/**
Creates a Color from a dictionary of 4 NSNumbers
Keys: @"h",@"s",@"b",@"a"
Keys: kColoursHSBA_H, kColoursHSBA_S, kColoursHSBA_B, kColoursHSBA_A
@param hsbaDictionary 4 NSNumbers for rgba between 0 - 1
@return Color
*/
Expand All @@ -125,13 +125,13 @@ typedef NS_ENUM(NSInteger, ColorFormulation) {
- (NSArray *)hsbaArray;

/**
Creates a dictionary of 4 NSNumbers representing float values with keys: "r", "g", "b", "a"
Creates a dictionary of 4 NSNumbers representing float values with keys: kColoursRGBA_R, kColoursRGBA_G, kColoursRGBA_B, kColoursRGBA_A
@return NSDictionary
*/
- (NSDictionary *)rgbaDictionary;

/**
Creates a dictionary of 4 NSNumbers representing float values with keys: "h", "s", "b", "a"
Creates a dictionary of 4 NSNumbers representing float values with keys: kColoursHSBA_H, kColoursHSBA_S, kColoursHSBA_B, kColoursHSBA_A
@return NSDictionary
*/
- (NSDictionary *)hsbaDictionary;
Expand Down

0 comments on commit ae10e59

Please sign in to comment.