-
Notifications
You must be signed in to change notification settings - Fork 144
Check the module name to know when to skip inherited doc comments. #314
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
Merged
d-ronnqvist
merged 5 commits into
swiftlang:main
from
d-ronnqvist:check-doc-comment-module-info
Jun 21, 2022
Merged
Check the module name to know when to skip inherited doc comments. #314
d-ronnqvist
merged 5 commits into
swiftlang:main
from
d-ronnqvist:check-doc-comment-module-info
Jun 21, 2022
Conversation
This file contains hidden or 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
@swift-ci please test |
@swift-ci please test |
# Conflicts: # Package.resolved # Sources/SwiftDocC/Infrastructure/DocumentationContext.swift # Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphRelationshipsBuilder.swift
@swift-ci please test |
QuietMisdreavus
approved these changes
Jun 21, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
@swift-ci please test |
@swift-ci please test |
d-ronnqvist
added a commit
to d-ronnqvist/swift-docc
that referenced
this pull request
Jun 21, 2022
…wiftlang#314) * Check the module name to know when to skip inherited doc comments. * Fallback to the previous logic when the new doc comment info is missing * Use new function in SymbolKit that handles older symbol graph versions * Use merged version of SymbolKit changes
d-ronnqvist
added a commit
that referenced
this pull request
Jun 23, 2022
…ts. (#316) * Check the module name to know when to skip inherited doc comments. (#314) * Check the module name to know when to skip inherited doc comments. * Fallback to the previous logic when the new doc comment info is missing * Use new function in SymbolKit that handles older symbol graph versions * Use merged version of SymbolKit changes * Depend on cherry-picked SymbolKit changes * Update to depend on additional cherry-picked SymbolKit changes * Use merged version of SymbolKit changes
2 tasks
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.
Bug/issue #, if applicable: rdar://92185538
Summary
This updates Swift-DocC to use the new doc comment module information added in swiftlang/swift#58857 and swiftlang/swift-docc-symbolkit#42 to know when
Dependencies
This directly depend on swiftlang/swift-docc-symbolkit#42
The new doc comment module information is only available with swiftlang/swift#58857
Testing
With a recent trunk toolchain that include swiftlang/swift#58857
Create a project with two targets.
In the first target, define some public type and define a public protocol with links to the public type in its documentation. For example:
In the second target, define a type that conform to the first target's protocol without overriding its documentation.
When building documentation for the second target, there shouldn't be warnings that the "Topic reference 'FirstStruct' couldn't be resolved."
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
AddedUpdated tests./bin/test
script and it succeeded