NSSet makes Jazzy forget the rest of the line

[akac]

Given our framework, we have this protocol line:

- (void)myObject:(nonnull MyManager *) myManager crossedLimitBoundariesWithExitedZones:(nullable NSSet <MyLimit *> *)exitedLimits enteredZones:(nullable NSSet <MyLimit *> *)enteredLimits;

Jazzy produces the following for Swift:

optional func myObject(_ myManager: MyManager, crossedLimitBoundariesWithExitedZones exitedLimits: Set

If I switch it to an NSArray (which obviously doesn't work for us since this SDK is already in use), Jazzy produces the correct HTML.

sdk: iphonesimulator
author: Me
author_url: http://developer.me.com
copyright: Me
module: MyProject
module_version: 3.1.0
theme: apple
readme: README.md
hide_documentation_coverage: true
umbrella_header: MyProject/MyProjectUmbrella.h
objc: true

Is this a Jazzy bug or is there a workaround that doesn't require changing the SDK itself?

[johnfairh]

Works for me on latest Jazzy + Xcode 9.1 / Xcode 9.0.1 (although I have to scroll right to see the whole line)

/

The truncation at the angle bracket sounds like some escaping not happening; be interesting to find out what you have xcode-selected -- was something similar with '&' during Xcode 9 ?beta. If the same as my test though then I think will need a complete minimal example to play with. Might be to do with how your other types are defined.

[akac]

I was using Xcode 8 in this case because the framework we're building for is on Xcode 8. We have a newer version that's on Xcode 9, but that's not being released yet.

I'll try it on Xcode 9.1 and see if that improves. In my case - it wasn't a scrolling issue as I checked the actual HTML being generated.

[johnfairh]

I found an Xcode 8.0 install I'd forgotten about + this immediately recreated, it is a SourceKit bug to do with XML escapes that has been since fixed. Tentatively closing this issue - use Xcode 9. SourceKitten could probably work around this but it's not that pretty.

  ▿ 9 : 2 elements
    - key : "key.doc.full_as_xml"
    - value : "<Function isInstanceMethod=\"1\" file=\"/Users/johnf/project/ObjCTester/ObjCTester/Header.h\" line=\"33\" column=\"1\">
<Name>giveSet:</Name><USR>c:objc(cs)AClass(im)giveSet:</USR>
<Declaration>func give(_ theSet: Set<AClass>?)</Declaration><Abstract>
<Para> does NSSet work?</Para></Abstract></Function>"

[akac]

I am using Xcode 9.1 - still same issue. Unless jazzy is somehow using Xcode 8 still - but I have my command line tools set to 9.1.

[johnfairh]

You're right, sorry about that! The Swift bug is still there in master. If you have a doc comment the XML escaping goes wrong; if you do not have a doc comment it is fine.

[jpsim]

Thanks for fixing this @johnfairh. Will you update SourceKitten here or would you like me to do that?

[johnfairh]

I will give it a shot.

[johnfairh]

Fixed in master.