From ea3dbd43bed48a1d7c043bb9a897c6c2671e1631 Mon Sep 17 00:00:00 2001 From: rentzsch Date: Tue, 11 Dec 2012 00:10:54 -0600 Subject: [PATCH] maybe GFM bolding can't have spaces? --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 37c687c..7fa6405 100644 --- a/README.md +++ b/README.md @@ -23,25 +23,25 @@ write: This will generate the previous `typedef enum` and will also generate a corresponding suite of functions: -** NSString\* StreamStateToString(int value) ** +**NSString\* StreamStateToString(int value)** Given a value, will return the enum's string representation. For example `StreamStateToString(2)` would return `@"Stream_Connecting"`. When confronted with values not defined in the enumeration, this function will return a placeholder string explaining the situation. For example `StreamStateToString(2000)` would return `@""`. -** BOOL StreamStateFromString(NSString \*enumLabel, StreamState \*enumValue) ** +**BOOL StreamStateFromString(NSString \*enumLabel, StreamState \*enumValue)** Attempts to return the enum's `int` value given its label. For example `StreamStateFromString(@"Stream_Disconnecting", &value)` would return `YES` and set `value` to `3`. This function returns `NO` if the label for the enum type is unknown. For example `StreamStateFromString(@"lackadaisical", &value)` would return `NO` and leave `value` untouched. -** NSDictionary\* StreamStateByValue() ** +**NSDictionary\* StreamStateByValue()** Returns a dictionary whose keys are the enum's values. Used by StreamStateToString(). When enums have multiple overlapping values, the current implementation exhibits last-write-wins behavior. -** NSDictionary\* StreamStateByLabel() ** +**NSDictionary\* StreamStateByLabel()** Returns a dictionary whose keys are the enum's labels. Used by StreamStateFromString(). This is the function you want if you wish to enumerate an enum's labels and values at runtime.