Add API documentation to Maps and fix TimeChangedEventArgs placeholders#33666
Merged
jfversluis merged 2 commits intomainfrom Jan 22, 2026
Merged
Add API documentation to Maps and fix TimeChangedEventArgs placeholders#33666jfversluis merged 2 commits intomainfrom
jfversluis merged 2 commits intomainfrom
Conversation
- Add complete XML documentation to Microsoft.Maui.Maps (Core) public API - Document Distance, MapSpan, GeographyUtils, and all interfaces - Document MapHandler, MapElementHandler, MapPinHandler and their interfaces - Enable CS1591 warnings-as-errors in Maps.csproj to prevent future gaps - Fix TimeChangedEventArgs docs (remove 'To be added.' placeholders)
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive XML documentation to the Microsoft.Maui.Maps project and fixes placeholder documentation in Controls.Core. The primary goal is to eliminate undocumented public APIs and enforce documentation standards going forward.
Changes:
- Adds complete XML documentation to core Maps types (Distance, MapSpan, GeographyUtils)
- Documents Maps handler classes and interfaces (MapHandler, MapElementHandler, MapPinHandler and their interfaces)
- Documents map element types (IGeoPathMapElement, IMapPin)
- Enables CS1591 as error in Maps.csproj to prevent future documentation gaps
- Replaces "To be added." placeholders in TimeChangedEventArgs with meaningful documentation
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/Core/maps/src/Maps.csproj | Removes CS1591 from NoWarn and adds it to WarningsAsErrors to enforce documentation |
| src/Core/maps/src/Primitives/Distance.cs | Adds documentation for struct, constructor, properties, factory methods, and operators |
| src/Core/maps/src/Primitives/MapSpan.cs | Adds documentation for class, constructor, properties, and methods |
| src/Core/maps/src/Primitives/GeographyUtils.cs | Adds documentation for utility extension methods |
| src/Core/maps/src/Core/IGeoPathMapElement.cs | Adds interface documentation |
| src/Core/maps/src/Core/IMapPin.cs | Adds documentation for previously undocumented members |
| src/Core/maps/src/Handlers/Map/IMapHandler.cs | Adds interface documentation with inheritdoc tags |
| src/Core/maps/src/Handlers/Map/MapHandler.cs | Adds handler class documentation |
| src/Core/maps/src/Handlers/MapElement/IMapElementHandler.cs | Adds interface documentation with inheritdoc tags |
| src/Core/maps/src/Handlers/MapElement/MapElementHandler.cs | Adds handler class documentation |
| src/Core/maps/src/Handlers/MapElement/MapElementHandlerUpdate.cs | Adds record documentation with parameter descriptions |
| src/Core/maps/src/Handlers/MapPin/IMapPinHandler.cs | Adds interface documentation with inheritdoc tags |
| src/Core/maps/src/Handlers/MapPin/MapPinHandler.cs | Adds handler class documentation |
| src/Controls/src/Core/TimeChangedEventArgs.cs | Removes "To be added." placeholders and improves documentation clarity |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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 complete XML documentation to the Microsoft.Maui.Maps project and fixes documentation placeholders in Controls.Core.
Changes
Core/maps documentation added:
Distancestruct - constructor, properties, factory methods, operatorsMapSpanclass - constructor, properties, methodsGeographyUtilsclass - extension methodsIGeoPathMapElement,IMapPininterfaces - previously undocumented membersIMapHandler,IMapElementHandler,IMapPinHandlerinterfacesMapHandler,MapElementHandler,MapPinHandlerhandler classesMapElementHandlerUpdaterecordCS1591 enforcement:
WarningsAsErrors: CS1591inMaps.csprojto prevent future documentation gapsControls.Core fix:
TimeChangedEventArgs- removed "To be added." placeholder documentationTesting
dotnet build src/Core/maps/src/Maps.csproj -c Release- passes with CS1591 enforceddotnet build src/Controls/Maps/src/Controls.Maps.csproj -c Release- passesdotnet build src/Controls/src/Core/Controls.Core.csproj -c Release- passes