Add underscored API documentation comments#909
Merged
Conversation
🤖 Augment PR SummarySummary: This PR improves API documentation coverage for several underscored but public OpenSwiftUI/OpenSwiftUICore types and members. Changes:
Technical Notes: Changes are documentation-only and aim to align wording with OpenSwiftUI naming and swift-docc conventions. 🤖 Was this summary useful? React with 👍 or 👎 |
| // MARK: - _PerformanceTest [6.4.41] | ||
|
|
||
| /// A performance test that will be executed by PPT. | ||
| @available(OpenSwiftUI_v1_0, *) |
| // MARK: - _ColorMatrix | ||
|
|
||
| /// A color matrix. The result of applying to a color is produced by | ||
| /// multiplying the color by the square matrix formed by the first |
There was a problem hiding this comment.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #909 +/- ##
==========================================
- Coverage 26.35% 26.33% -0.02%
==========================================
Files 710 710
Lines 49537 49537
==========================================
- Hits 13053 13048 -5
- Misses 36484 36489 +5 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Agent Summary
Adds missing documentation comments for selected underscored public API surfaces.
The update places comments on the primary type or protocol declarations where appropriate, and avoids repeating identical comments on default implementations. It also keeps the wording aligned with OpenSwiftUI naming.
Validation:
git diff --check.SwiftUIwording anddoc://links.