Add markup delimiters supported by Xcode #654
Open
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
|
Thanks for the PR! To update fixtures, you can set the OVERWRITE_FIXTURES or APPEND_FIXTURES environment variables while running the tests. |
jpsim
reviewed
May 30, 2020
Comment on lines
+464
to
+465
| // .replacingOccurrences(of: "<strong>", with: "**") | ||
| // .replacingOccurrences(of: "</strong>", with: "**") |
There was a problem hiding this comment.
Don't have tests, will probably remove from this PR, or add tests.
jpsim
reviewed
May 30, 2020
| import SourceKittenFramework | ||
| import XCTest | ||
|
|
||
| let markupDelmitersXML = """ |
There was a problem hiding this comment.
Maybe this could be a file in the Fixtures/ directory instead?
There was a problem hiding this comment.
I wasn't sure how fixtures are set up, but sounds like a good idea.
|
@jpsim @norio-nomura I'm going to need some help getting these fixtures fixed for all Swift versions supported. Any suggestions? |
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.
Summary
This PR adds support for documentation markup delimiters supported by Xcode (see full list of markup delimiters).
Code changes
parseFullXMLDocsmethod inFile.swiftto extractAbstract,ThrowsDiscussionand other supported delimiters from XML documentparseFullXMLDocsto support emphasis by replacing<emphasis>with_SwiftDocKeyenumSwiftDocMarkupDelimiterTeststo test each supported delimiterNote: Some fixtures are pending to be updated, will fix soon. Any help by maintainers would be appreciated.