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

Accommodating Improper Usage for Documenting Objective-C #554

Closed
Mozahler opened this issue May 9, 2016 · 1 comment
Closed

Accommodating Improper Usage for Documenting Objective-C #554

Mozahler opened this issue May 9, 2016 · 1 comment
Assignees
Milestone

Comments

@Mozahler
Copy link

Mozahler commented May 9, 2016

I love jazzy, but I struggle with the Objective C Documentation process. If I download a trending project from GitHub, often many of the classes are documented well in the .m files but not the .h files. If I put the .m file names in the umbrella header, jazzy blows up. Besides copying the comments to the .h files, is there a less manually intensive way of getting needed results?

jazzy
Using config file /Users/Alex/Downloads/DateTools-master/.jazzy.yaml
fatal error: Unsupported CXCursorKind: ObjCImplementationDecl: 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/Alex/Downloads/DateTools-master/DateTools/Umbrella.h", "--", "-x", "objective-c", "-isysroot", "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator9.3.sdk", "-I", "/Users/Alex/Downloads/DateTools-master/DateTools"

fatal error: Unsupported CXCursorKind: ObjCImplementationDecl: 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:inblock 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:inbuild'
from /Library/Ruby/Gems/2.0.0/gems/jazzy-0.6.0/bin/jazzy:15:in <top (required)>' from /usr/local/bin/jazzy:23:inload'
from /usr/local/bin/jazzy:23:in `

'

@jpsim
Copy link
Collaborator

jpsim commented May 19, 2016

The Objective-C interface is extremely unforgiving. We're tracking making improvements to this in #399 and jpsim/SourceKitten#88

@jpsim jpsim closed this as completed May 19, 2016
@istx25 istx25 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

No branches or pull requests

3 participants