Migrate Shapes namespace API docs from external XML to inline#33627
Merged
jfversluis merged 1 commit intomainfrom Jan 21, 2026
Merged
Migrate Shapes namespace API docs from external XML to inline#33627jfversluis merged 1 commit intomainfrom
jfversluis merged 1 commit intomainfrom
Conversation
- Migrate all 44 Shapes classes from external XML doc references to inline XML documentation - Delete src/Controls/docs/Microsoft.Maui.Controls.Shapes/ directory (44 XML files) - Update documentation to be concise and follow guidelines - Add 'This is a bindable property.' where appropriate Part of API documentation coverage improvement initiative.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates API documentation for the Shapes namespace from external XML files to inline XML doc comments. The migration covers 44 classes including shape types (Shape, Line, Ellipse, Rectangle, Polygon, Polyline, Path), geometry classes, path segments, transforms, and supporting types. Documentation has been made concise (1-2 lines) following the stated guidelines, and "This is a bindable property." notation has been added where appropriate.
Changes:
- Migrated all inline documentation from
<include>references to inline<summary>,<param>, and other XML doc tags - Deleted 44 XML documentation files from
src/Controls/docs/Microsoft.Maui.Controls.Shapes/ - Standardized documentation format across all Shapes namespace classes
Reviewed changes
Copilot reviewed 88 out of 88 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| TranslateTransform.cs | Added inline docs for translation transform |
| TransformTypeConverter.cs | Added inline docs for transform type converter |
| TransformGroup.cs | Added inline docs for composite transform group |
| TransformCollection.cs | Added inline docs for transform collection |
| Transform.cs | Added inline docs for base transform class |
| SkewTransform.cs | Added inline docs for skew transform |
| Shape.cs | Added inline docs for base shape class |
| ScaleTransform.cs | Added inline docs for scale transform |
| RotateTransform.cs | Added inline docs for rotation transform |
| RectangleGeometry.cs | Added inline docs for rectangle geometry |
| Rectangle.cs | Added inline docs for rectangle shape |
| QuadraticBezierSegment.cs | Added inline docs for quadratic bezier path segment |
| Polyline.cs | Added inline docs for polyline shape |
| Polygon.cs | Added inline docs for polygon shape |
| PolyQuadraticBezierSegment.cs | Added inline docs for multi-quadratic bezier segment |
| PolyLineSegment.cs | Added inline docs for multi-line path segment |
| PolyBezierSegment.cs | Added inline docs for multi-bezier path segment |
| PointCollectionConverter.cs | Added inline docs for point collection converter |
| PenLineJoin.cs | Added inline docs for line join enumeration |
| PenLineCap.cs | Added inline docs for line cap enumeration |
| PathSegmentCollection.cs | Added inline docs for path segment collection |
| PathSegment.cs | Added inline docs for base path segment class |
| PathGeometryConverter.cs | Added inline docs for path geometry converter |
| PathGeometry.cs | Added inline docs for path geometry |
| PathFigureCollectionConverter.cs | Added inline docs for path figure collection converter |
| PathFigureCollection.cs | Added inline docs for path figure collection |
| PathFigure.cs | Added inline docs for path figure |
| Path.cs | Added inline docs for path shape |
| MatrixTypeConverter.cs | Added inline docs for matrix type converter |
| MatrixTransform.cs | Added inline docs for matrix transform |
| Matrix.cs | Added inline docs for matrix struct |
| LineSegment.cs | Added inline docs for line path segment |
| LineGeometry.cs | Added inline docs for line geometry |
| Line.cs | Added inline docs for line shape |
| GeometryHelper.cs | Added inline docs for geometry helper methods |
| GeometryGroup.cs | Added inline docs for geometry group |
| GeometryCollection.cs | Added inline docs for geometry collection |
| Geometry.cs | Added inline docs for base geometry class |
| FillRule.cs | Added inline docs for fill rule enumeration |
| EllipseGeometry.cs | Added inline docs for ellipse geometry |
| Ellipse.cs | Added inline docs for ellipse shape |
| CompositeTransform.cs | Added inline docs for composite transform |
| BezierSegment.cs | Added inline docs for bezier path segment |
| ArcSegment.cs | Added inline docs for arc path segment |
| [44 XML files deleted] | Removed external XML documentation files |
StephaneDelcroix
approved these changes
Jan 21, 2026
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.
Note
Are you waiting for the changes in this PR to be merged?
It would be very helpful if you could test the resulting artifacts from this PR and let us know in a comment if this change resolves your issue. Thank you!
Description
This PR migrates API documentation for the Shapes namespace from external XML files to inline XML doc comments.
What was done:
Files migrated:
This is PR 1 of a series to achieve 100% API documentation coverage.