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

AllPublicDeclarationsHaveDocumentation doesn't check enums, actors, or nested declarations #778

Closed
shawnhyam opened this issue Jul 24, 2024 · 1 comment

Comments

@shawnhyam
Copy link
Contributor

shawnhyam commented Jul 24, 2024

public enum Foo {}

public actor Bar {}

/// Comment
public struct X {
    public func baz() {}
}

Foo, Bar, and baz are all public declarations, but no warning will be emitted for missing a doc comment. The same issue also exists with BeginDocumentationCommentWithOneLineSummary and UseSynthesizedInitializer (nested structs will be skipped).

@ahoppen
Copy link
Member

ahoppen commented Jul 24, 2024

Synced to Apple’s issue tracker as rdar://132401334

shawnhyam added a commit to shawnhyam/swift-format that referenced this issue Jul 24, 2024
allevato added a commit that referenced this issue Aug 2, 2024
Make rules work even inside of nested data structures. Fixes #778.
thunderseethe pushed a commit to thunderseethe/swift-format that referenced this issue Aug 13, 2024
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

No branches or pull requests

2 participants