plank icon indicating copy to clipboard operation
plank copied to clipboard

Improve slightly unintuitive behavior of enum "description" field

Open levi opened this issue 8 years ago • 0 comments

My intuition was to use the field "description" on an enum value to describe the purpose of the value. However, "description" is used to generate the enum name. It seems like it might make more sense to decouple name and description.

Setting a description like this:

    "enum": [
       { "default" : "unknown", "description" : "Default value. This is not a value that the API will return."},

Generates this output which doesn't compile:

    typedef NS_ENUM(NSInteger, PIPinSafetyStatusRedirectStatusType) {
        PIPinSafetyStatusRedirectStatusTypeDefault Value. This Is Not A Value That The Api Will Return. /* unknown */,

levi avatar Mar 09 '17 00:03 levi