Skip to content

[5.3][Serialization] Skip SPI documentation in swiftdoc files #32075

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 29, 2020
Merged

[5.3][Serialization] Skip SPI documentation in swiftdoc files #32075

merged 1 commit into from
May 29, 2020

Conversation

xymus
Copy link
Contributor

@xymus xymus commented May 28, 2020 •
edited
Loading

Cherry-pick of #32070.

  • Explanation: The swiftdoc file holds the documentation on all public declarations, including SPI declarations. As a temporary solution to hide SPI documentation, treat the SPI decls as private and hide their documentation from the swiftdoc file. The long term solution would be to emit two swiftdoc files, one private and one public.
  • Scope: The change affects only the emitted swiftdoc files for declarations using the @_spi attribute.
  • Risk: Very low
  • Testing: Added a test case.
  • Resolves rdar://63729195
  • Reviewed by: @DougGregor

@xymus
[Serialization] Skip SPI documentation in swiftdoc files
85125f8 
Hide comments from SPI decls in all swiftdoc files. This applies the
same restrictions as private declarations. This is a temporary solution,
a long term fix is to emit both a public and an internal swiftdoc file.

rdar://63729195
@xymus xymus added the r5.3 label May 28, 2020
@xymus xymus requested a review from a team as a code owner May 28, 2020 21:33
@xymus
Copy link
Contributor Author

xymus commented May 28, 2020

@swift-ci Please test

@xymus
Copy link
Contributor Author

xymus commented May 28, 2020

@swift-ci please nominate

@swift-ci
Copy link
Contributor

Build failed
Swift Test OS X Platform
Git Sha - 85125f8

@xymus
Copy link
Contributor Author

xymus commented May 29, 2020

@swift-ci Please test OS X

@tkremenek tkremenek merged commit 1c00f54 into swiftlang:release/5.3 May 29, 2020
@xymus xymus deleted the spi-swiftdoc-5.3 branch October 31, 2022 21:02
@AnthonyLatsis AnthonyLatsis added swift 5.3 🍒 release cherry pick Flag: Release branch cherry picks labels Jan 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tkremenek tkremenek tkremenek approved these changes

Assignees
No one assigned
Labels
🍒 release cherry pick Flag: Release branch cherry picks swift 5.3
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@xymus @swift-ci @tkremenek @AnthonyLatsis