Add comprehensive API documentation for GradientStop class#33477
Merged
Add comprehensive API documentation for GradientStop class#33477
Conversation
Co-authored-by: jfversluis <939291+jfversluis@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Improve API documentation for GradientOffset
Add comprehensive API documentation for GradientStop class
Jan 12, 2026
Member
|
@copilot don't add the "To be added." comments, remove them or add something meaningful. Additionally, don't use the T: and P: prefixes, use the strongly typed references |
Co-authored-by: jfversluis <939291+jfversluis@users.noreply.github.com>
Contributor
Author
Updated in commit 10fa566:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive API documentation for the GradientStop class, addressing issue #3162. The documentation includes detailed summaries, remarks, parameter descriptions, and return value documentation for all public members following the Code Documentation Guidelines.
Changes:
- Added class-level documentation with summary and remarks explaining the purpose and usage of GradientStop
- Documented both constructors (default and parameterized) with summaries and remarks
- Added complete documentation for Color and Offset properties including summaries, value descriptions, and detailed remarks
- Documented BindableProperty identifiers for ColorProperty and OffsetProperty
- Added documentation for Equals and GetHashCode methods
This was referenced Jan 12, 2026
Open
rmarinho
approved these changes
Jan 13, 2026
kubaflo
pushed a commit
to kubaflo/maui
that referenced
this pull request
Jan 16, 2026
) Fixes dotnet/docs-maui#3162 - [x] Understand issue dotnet#3162 and documentation guidelines - [x] Review existing GradientStop.cs and GradientStop.xml files - [x] Examine usage patterns in test files and code examples - [x] Add XML documentation for GradientStop.Offset property - [x] Add XML documentation for GradientStop.Color property - [x] Add XML documentation for GradientStop class and constructors - [x] Format documentation and verify consistency - [x] Verify documentation follows CodeDocumentationGuidelines.md - [x] Remove T: and P: prefixes from all cref references - [x] Replace all "To be added" remarks with meaningful content <!-- START COPILOT CODING AGENT SUFFIX --> <!-- START COPILOT ORIGINAL PROMPT --> <details> <summary>Original prompt</summary> > Please improve the API docs for GradientOffset as per this issue: dotnet/docs-maui#3162. Follow the documentation instructions from https://github.com/dotnet/maui/blob/main/docs/CodeDocumentationGuidelines.md </details> <!-- START COPILOT CODING AGENT TIPS --> --- 💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more [Copilot coding agent tips](https://gh.io/copilot-coding-agent-tips) in the docs. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jfversluis <939291+jfversluis@users.noreply.github.com>
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixes dotnet/docs-maui#3162
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.