Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@compatibility_alias statements cause SourceKitten to barf #543

Closed
frankus opened this issue Apr 26, 2016 · 1 comment · Fixed by #562
Closed

@compatibility_alias statements cause SourceKitten to barf #543

frankus opened this issue Apr 26, 2016 · 1 comment · Fixed by #562
Assignees
Milestone

Comments

@frankus
Copy link

frankus commented Apr 26, 2016

This might be a SourceKitten issue, but it's probably useful to have it documented here:

If your source file includes a @compatibility_alias declaration, you will get the following output:

fatal error: Unsupported CXCursorKind: UnexposedDecl: file /Users/jp/Projects/jazzy/SourceKitten/Source/SourceKittenFramework/ObjCDeclarationKind.swift, line 71
/Library/Ruby/Gems/2.0.0/gems/jazzy-0.6.0/lib/jazzy/executable.rb:36:in `execute_command': /Library/Ruby/Gems/2.0.0/gems/jazzy-0.6.0/lib/jazzy/SourceKitten/bin/sourcekitten ["doc", "--objc", "/Users/<redacted_path_would_go_here>.h", "--", "-x", "objective-c", "-isysroot", "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator9.3.sdk", "-I", "/Users/<redacted_path_would_go_here>"] (RuntimeError)

fatal error: Unsupported CXCursorKind: UnexposedDecl: file /Users/jp/Projects/jazzy/SourceKitten/Source/SourceKittenFramework/ObjCDeclarationKind.swift, line 71
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.6.0/lib/jazzy/sourcekitten.rb:142:in `run_sourcekitten'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.6.0/lib/jazzy/doc_builder.rb:56:in `block in build'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.6.0/lib/jazzy/doc_builder.rb:54:in `chdir'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.6.0/lib/jazzy/doc_builder.rb:54:in `build'
    from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.6.0/bin/jazzy:15:in `<top (required)>'
    from /usr/local/bin/jazzy:23:in `load'
    from /usr/local/bin/jazzy:23:in `<main>'

A workaround is to comment out the declaration, generate your docs, and then uncomment.

@jpsim
Copy link
Collaborator

jpsim commented May 19, 2016

Thanks for reporting this! I'm sorry I was so let to get to this, but I just pushed a fix in #562... would you mind confirming that you can now generate docs for your project using that branch? Thanks!

esad pushed a commit to PSPDFKit-labs/jazzy that referenced this issue May 27, 2016
@pigeon-archive pigeon-archive modified the milestone: The Past Nov 22, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants