Add option to create only Swift or Objc docs out of Objc headers

[ulukaya]

For Objc headers,
Create the a switch/nav to go between swift/objc version or just
add an argument to create only objc or only swift docs, so the switch/nav could be added manually afterwards.

[colincornaby]

Would also be nice if this account for things like Swift class names being different than Obj-C class names. I'm finding this annoying when reviewing our documentation. It defaults to the Obj-C ones, but the Swift ones are not present.

[jpsim]

Objective-C docs have Swift declarations that include the SWIFT_NAME, just as imported by ClangImporter.

[ulukaya]

Hey @jpsim , do you mind giving me some pointers on where I can address this? To create only objc, or only swift docs out of objc headers. I can work on it and contribute back.

[ulukaya]

The only gotcha is we need to make sure we use swift names for left nav. So not the objc but the NS_Swift_Name names are default everywhere.

[jpsim]

This should be pretty easy to do. Add a configuration flag here (e.g. hide_objc_declarations/hide_swift_declarations): https://github.com/realm/jazzy/blob/master/lib/jazzy/config.rb

Then depending on whether or not the flag is set, set or don't set declaration/other_language_declaration here:

jazzy/lib/jazzy/doc_builder.rb

Lines 341 to 342 in 3895676

	declaration: item.declaration,
	other_language_declaration: item.other_language_declaration,

[ulukaya]

when you don't see declaration, you don't get other_language_declaration either for some reason.
Anyways I can always trick that but setting declaration: item.other_language_declaration

But the real issue is I want to get Swift type names for types, instead of objective-c ones. Is there an easy way to do it? Am I even getting them from sourcekitten?

[ulukaya]

So I want to use SWIFT_NAME instead of name as type names.

[jpsim]

The SWIFT_NAME is never specifically returned, however I think it's included in the cursorInfo dictionary here: https://github.com/jpsim/SourceKitten/blob/d841db12a0911239ba4071ea729b79c946f2bdd8/Source/SourceKittenFramework/Clang%2BSourceKitten.swift#L220

So you could extend SourceKitten to also include that.

[ulukaya]

Like this https://github.com/jpsim/SourceKitten/pull/453/files . ? @jpsim

[ulukaya]

or is it docName?

[jpsim]

You'll need to look at the contents of the dictionary in cursorInfo to determine what it is that you want.

[ulukaya]

actually "name" was what I needed. So it was all good. I just couldn't test it earlier due to not knowing how to deal with "@rpath". All good now.

[ulukaya]

jpsim/SourceKitten#456 should do the work. Tested and works fine.

[ulukaya]

#923

[ulukaya]

@jpsim #923 should solve this.

[jpsim]

Merged in b139d92.