Render Swift declarations for Objective-C declarations #530
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jpsim
changed the title
| name: item.name, | ||
| abstract: render_markdown(abstract), | ||
| declaration: item.declaration, | ||
| other_language_declaration: item.other_language_declaration, |
There was a problem hiding this comment.
to be generic, this should probably be a hash, languages to their ddeclarations
There was a problem hiding this comment.
happy to do that when we get there. for now, this is a bit simpler.
jpsim
changed the title
|
Here's what Objective-C docs looks like with this PR:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This points SourceKitten to jpsim/SourceKitten#95 in order to render the equivalent Swift declarations when generating Objective-C docs. I might not be able to revisit this for a little while, so if anyone else wants to pitch in, you're certainly welcome to do so /cc @esad @jverkoey @orta @jessesquires
Integration specs diff is here: https://github.com/realm/jazzy-integration-specs/compare/jp-render-swift-declarations-in-objc
For some reason (probably unrelated updates to SourceKitten), some extensions docs are now missing, which needs some investigation, hence the call for help above.