Add XML documentation to Controls.Core.Design and enable CS1591#33680
Merged
Add XML documentation to Controls.Core.Design and enable CS1591#33680
Conversation
- Add documentation to all 24 design-time type converter classes - Add XML docs to KnownValuesDesignTypeConverter base class - Add SafeAreaEdgesTypeDesignConverter.cs to csproj - Enable GenerateDocumentationFile and WarningsAsErrors CS1591 - Build verified with 0 warnings, 0 errors
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds XML documentation to all public members in the Microsoft.Maui.Controls.Core.Design project and enables CS1591 as a warning-as-error to enforce documentation coverage going forward. This represents the final project needed for 100% API documentation coverage across the MAUI repository.
Changes:
- Added XML documentation summaries to 24 type converter classes
- Added
<inheritdoc/>tags for overridden base class methods - Enabled
GenerateDocumentationFileandWarningsAsErrors: CS1591in the project file - Added SafeAreaEdgesTypeDesignConverter.cs to the compile items list
Reviewed changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| Controls.Core.Design.csproj | Enabled XML documentation generation and CS1591 as error; added SafeAreaEdgesTypeDesignConverter to build |
| BoundsDesignTypeConverter.cs | Added XML documentation for design-time Bounds type conversion |
| ButtonContentDesignTypeConverter.cs | Added XML documentation for button content layout conversion |
| ColorDesignTypeConverter.cs | Added XML documentation for Color values conversion |
| ConstraintDesignTypeConverter.cs | Added XML documentation for constraint values conversion |
| CornerRadiusDesignTypeConverter.cs | Added XML documentation for CornerRadius conversion |
| EasingDesignTypeConverter.cs | Added XML documentation for Easing function conversion |
| FlexEnumDesignTypeConverters.cs | Added XML documentation for all FlexLayout-related converters (Justify, Direction, AlignContent, AlignItems, AlignSelf, Wrap, Basis) |
| FlowDirectionDesignTypeConverter.cs | Added XML documentation for FlowDirection conversion |
| FontSizeDesignTypeConverter.cs | Added XML documentation for font size conversion |
| GridLengthDesignTypeConverter.cs | Added XML documentation for GridLength conversion |
| GridLengthCollectionDesignTypeConverter.cs | Added XML documentation for GridLength collection conversion |
| ImageSourceDesignTypeConverter.cs | Added XML documentation for ImageSource conversion |
| ItemsLayoutDesignTypeConverter.cs | Added XML documentation for items layout conversion |
| KeyboardDesignTypeConverter.cs | Added XML documentation for Keyboard type conversion |
| KnownValuesDesignTypeConverter.cs | Added XML documentation for base converter class with known values |
| LayoutOptionsDesignTypeConverter.cs | Added XML documentation for LayoutOptions conversion |
| LinearItemsLayoutDesignTypeConverter.cs | Added XML documentation for LinearItemsLayout conversion |
| PointTypeDesignConverter.cs | Added XML documentation for Point conversion |
| RectTypeDesignConverter.cs | Added XML documentation for Rect conversion |
| SafeAreaEdgesTypeDesignConverter.cs | Added XML documentation for SafeAreaEdges conversion |
| ThicknessTypeDesignConverter.cs | Added XML documentation for Thickness conversion |
| VisibilityDesignTypeConverter.cs | Added XML documentation for visibility conversion |
| VisualDesignTypeConverter.cs | Added XML documentation for Visual values conversion |
src/Controls/src/Core.Design/SafeAreaEdgesTypeDesignConverter.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
kubaflo
approved these changes
Jan 22, 2026
rmarinho
approved these changes
Jan 22, 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
Adds XML documentation to all public members in Microsoft.Maui.Controls.Core.Design (design-time tooling) and enables CS1591 as a warning-as-error to prevent future documentation gaps.
This is the final project needed for 100% API documentation coverage across the entire MAUI repository.
Changes
Type Converters Documented (24 files)
BoundsDesignTypeConverter- Bounds valuesButtonContentDesignTypeConverter- Button content layoutColorDesignTypeConverter- Color valuesConstraintDesignTypeConverter- Constraint valuesCornerRadiusDesignTypeConverter- Corner radiusEasingDesignTypeConverter- Easing functionsFlexJustifyDesignTypeConverter- FlexLayout justifyFlexDirectionDesignTypeConverter- FlexLayout directionFlexAlignContentDesignTypeConverter- FlexLayout align contentFlexAlignItemsDesignTypeConverter- FlexLayout align itemsFlexAlignSelfDesignTypeConverter- FlexLayout align selfFlexWrapDesignTypeConverter- FlexLayout wrapFlexBasisDesignTypeConverter- FlexLayout basisFlowDirectionDesignTypeConverter- Flow directionFontSizeDesignTypeConverter- Font sizesGridLengthDesignTypeConverter- Grid lengthsGridLengthCollectionDesignTypeConverter- Grid length collectionsImageSourceDesignTypeConverter- Image sourcesItemsLayoutDesignTypeConverter- Items layoutKeyboardDesignTypeConverter- Keyboard typesKnownValuesDesignTypeConverter- Base classLayoutOptionsDesignTypeConverter- Layout optionsLinearItemsLayoutDesignTypeConverter- Linear items layoutPointTypeDesignConverter- Point valuesRectTypeDesignConverter- Rect valuesSafeAreaEdgesTypeDesignConverter- Safe area regionsThicknessTypeDesignConverter- Thickness valuesVisibilityDesignTypeConverter- VisibilityVisualDesignTypeConverter- Visual valuesBuild Configuration
GenerateDocumentationFile: trueWarningsAsErrors: CS1591SafeAreaEdgesTypeDesignConverter.csto csprojStats