Skip to content

Cascade doc comments from protocol requirements to extensions #3301

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
merged 1 commit into from
Jul 29, 2016
Merged

Cascade doc comments from protocol requirements to extensions #3301

merged 1 commit into from
Jul 29, 2016

Conversation

bitjammer
Copy link
Contributor

This allows authors to not have to copy and paste doc comments
from requirements to default implementations to get documentation.

rdar://problem/16512247

@bitjammer
Copy link
Contributor Author

@swift-ci Please smoke test

1 similar comment
@bitjammer
Copy link
Contributor Author

@swift-ci Please smoke test

@@ -0,0 +1,73 @@
// RUN: %target-swift-ide-test -print-comments -source-filename %s | FileCheck %s
// REQUIRES: no_asan
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why no_asan?

@gribozavr
Copy link
Contributor

Thank you, this is really awesome!

@bitjammer
Copy link
Contributor Author

@swift-ci Please test

This allows authors to not have to copy and paste doc comments
from requirements to default implementations to get documentation.

For now, this will only be active if a protocol doesn't inherit
two equivalent requirements from other protocols with doc comments.
Those will need special treatment and it would be better not to just
copy and paste them into the same doc comment. More output structure
is needed to differentiate documentation for different protocols'
requirements.

rdar://problem/16512247
@bitjammer
Copy link
Contributor Author

@swift-ci Smoke test

@bitjammer bitjammer merged commit 136c8d4 into swiftlang:master Jul 29, 2016
@bitjammer bitjammer deleted the cascading-documentation-comments branch July 29, 2016 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants