(This is about the codebase of the generator, runtime, and transports, not about generated code.)
We should enable the following two rules in the .swift-format file of all our repos, to get more validation of documentation comments. I sometimes forget to rename properties in doc comments and this could help catch that. Plus it'll ensure that new code is documented properly.
ValidateDocumentationComments
AllPublicDeclarationsHaveDocumentation
- possibly other comments-related ones
(This is about the codebase of the generator, runtime, and transports, not about generated code.)
We should enable the following two rules in the
.swift-formatfile of all our repos, to get more validation of documentation comments. I sometimes forget to rename properties in doc comments and this could help catch that. Plus it'll ensure that new code is documented properly.ValidateDocumentationCommentsAllPublicDeclarationsHaveDocumentation