jazzy icon indicating copy to clipboard operation
jazzy copied to clipboard

NS_OPTIONS are treated as enums

Open colincornaby opened this issue 8 years ago • 6 comments

Jazzy seems to be documenting my NS_ENUMs, but it's not documenting my NS_OPTIONS. Is this a known issue or am I missing something? I'm using Jazzy with an Obj-C project.

colincornaby avatar Apr 21 '16 18:04 colincornaby

Seems to work fine for me, although jazzy treats it as an enum:

/// Some options.
typedef NS_OPTIONS(NSUInteger, SomeOptions) {
    /// Foo.
    SomeOptionsFoo = 0,
    /// Bar.
    SomeOptionsBar = 1 << 0,
};

image

Is this what you're seeing?

jpsim avatar Apr 22 '16 06:04 jpsim

No, it seems to get ignored. Let me take a look at the commentary around it and see if something is funny.

colincornaby avatar Apr 22 '16 22:04 colincornaby

I was missing the space in front of the /// which I didn't realize was required. Thanks! Not a bug.

colincornaby avatar Apr 22 '16 22:04 colincornaby

well, the fact that NS_OPTIONS are treated as enums I'd consider a bug, so let's keep this open.

jpsim avatar Apr 22 '16 22:04 jpsim

Any updates on this?

pigeon-archive avatar Nov 23 '16 15:11 pigeon-archive

wanna get chummy with libclang?

jpsim avatar Nov 26 '16 05:11 jpsim