Skip to content
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

[SR-539] Cascading documentation comments #43156

Open
gribozavr opened this issue Jan 14, 2016 · 1 comment
Open

[SR-539] Cascading documentation comments #43156

gribozavr opened this issue Jan 14, 2016 · 1 comment
Labels
bug A deviation from expected or documented behavior. Also: expected but undesirable behavior. good first issue Good for newcomers

Comments

@gribozavr
Copy link
Collaborator

Previous ID SR-539
Radar rdar://problem/16512247
Original Reporter @gribozavr
Type Bug
Additional Detail from JIRA
Votes 1
Component/s Source Tooling
Labels Bug, StarterBug
Assignee None
Priority Medium

md5: b8301471acb7f784c7f605035b40a5eb

Issue Description:

Swift should be able to find comments on 'related' decls: we should look at overridden superclass and protocol methods and properties, getters/setters should get comments from the property or subscript, etc.

@swift-ci
Copy link
Collaborator

Comment by Dave Addey (JIRA)

Conversely, I suggest that we shouldn't do this kind of substitution for comments on inherited types. For example, if a subclass doesn't have a doc comment, the superclass's doc comment is not a valid substitute.

(I completely agree that this would be useful for members, however.)

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug A deviation from expected or documented behavior. Also: expected but undesirable behavior. good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants