tomaz / appledoc

Objective-c code Apple style documentation set generator.
http://gentlebytes.com
4.2k stars 644 forks source link

Hi how write enum annotation? #610

Closed wokenshin closed 7 years ago

wokenshin commented 7 years ago

I would like to ask how the annotations should be written

tomaz commented 7 years ago

You need to use NS_ENUM variant, then use comments as normally:

/// enum comment
typedef NS_ENUM(NSUInteger, MyEnum) {
    /// option 1 comment
    Option1,

    /// option 2 comment
    Option2,
}
wokenshin commented 7 years ago

thank you very much