Skip to content

Enable documentation comment validation in swift-format #165

Closed
@czechboy0

Description

@czechboy0

(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

Metadata

Metadata

Assignees

Labels

area/documentationImprovements or additions to documentation.kind/enhancementImprovements to existing feature.size/SSmall task. (A couple of hours of work.)

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions