-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Add comprehensive API documentation for GradientStop class #33477
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: jfversluis <[email protected]>
|
@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 <[email protected]>
Updated in commit 10fa566:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
| <ReturnType>Microsoft.Maui.Graphics.Color</ReturnType> | ||
| </ReturnValue> | ||
| <Docs> | ||
| <summary>Gets or sets the color of the gradient stop. This is a bindable property.</summary> |
Copilot
AI
Jan 12, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to the Code Documentation Guidelines (line 14), bindable properties should have "This is a bindable property." at the END of the summary, not at the beginning. The summary should describe what the property does first, then end with "This is a bindable property."
For example, the summary should be structured as:
"Gets or sets the color of the gradient stop. This is a bindable property."
| <ReturnType>System.Single</ReturnType> | ||
| </ReturnValue> | ||
| <Docs> | ||
| <summary>Gets or sets the position of the gradient stop within the gradient. This is a bindable property.</summary> |
Copilot
AI
Jan 12, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
According to the Code Documentation Guidelines (line 14), bindable properties should have "This is a bindable property." at the END of the summary, not at the beginning. The summary should describe what the property does first, then end with "This is a bindable property."
For example, the summary should be structured as:
"Gets or sets the position of the gradient stop within the gradient. This is a bindable property."
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.