Add API documentation to Controls.Foldable and enable CS1591#33667
Merged
jfversluis merged 1 commit intomainfrom Jan 22, 2026
Merged
Add API documentation to Controls.Foldable and enable CS1591#33667jfversluis merged 1 commit intomainfrom
jfversluis merged 1 commit intomainfrom
Conversation
- Add XML documentation to DualScreenInfo constructor - Add XML documentation to HostBuilderExtensions.UseFoldable - Add XML documentation to TwoPaneView constructor - Add XML documentation to SpanModeStateTrigger constructor - Add XML documentation to WindowSpanModeStateTrigger constructor - Enable CS1591 warnings-as-errors in Controls.Foldable.csproj
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive API documentation to the Microsoft.Maui.Controls.Foldable project and enables CS1591 compiler warnings as errors to ensure all public APIs remain documented going forward.
Changes:
- Added XML documentation to all previously undocumented public constructors (DualScreenInfo, TwoPaneView, SpanModeStateTrigger, WindowSpanModeStateTrigger)
- Added class-level and method-level documentation to HostBuilderExtensions including proper parameter and return value tags
- Enabled CS1591 as a warning-as-error in Controls.Foldable.csproj to enforce documentation requirements
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/Controls/Foldable/src/DualScreenInfo.cs | Added constructor documentation explaining that it monitors the specified element's position across screens |
| src/Controls/Foldable/src/HostBuilderExtensions.cs | Added class summary and complete method documentation with parameter and return value tags for UseFoldable extension method |
| src/Controls/Foldable/src/TwoPaneView.cs | Added standard constructor documentation for the public parameterless constructor |
| src/Controls/Foldable/src/SpanModeStateTrigger.cs | Added standard constructor documentation for the public parameterless constructor |
| src/Controls/Foldable/src/WindowSpanModeStateTrigger.cs | Added standard constructor documentation for the public parameterless constructor |
| src/Controls/Foldable/src/Controls.Foldable.csproj | Changed CS1591 from NoWarn to WarningsAsErrors to enforce documentation requirements |
kubaflo
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
This PR adds API documentation to the Microsoft.Maui.Controls.Foldable project and enables CS1591 warnings-as-errors to prevent future documentation gaps.
Changes
Documentation added:
DualScreenInfoconstructorHostBuilderExtensions.UseFoldablemethodTwoPaneViewconstructorSpanModeStateTriggerconstructorWindowSpanModeStateTriggerconstructorCS1591 enforcement:
WarningsAsErrors: CS1591inControls.Foldable.csprojTesting
dotnet build src/Controls/Foldable/src/Controls.Foldable.csproj -c Release- passes with CS1591 enforced