Add missing documentation comments #157
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
All public declarations should have documentation comments, but a number did not. The linter configuration previously accepted these files but now rejects them; the linter depends on the upstream
swift
container image, which is updated from time to time.Modifications
Add documentation comments for public declarations identified by the format linter.
Result
All public declarations are documented.
Test Plan
The linter passes locally.
No functional change, all unit tests continue to pass.