Skip to content
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

Update Maps Project API Docs #20893

Merged
merged 4 commits into from Mar 1, 2024
Merged

Update Maps Project API Docs #20893

merged 4 commits into from Mar 1, 2024

Conversation

jfversluis
Copy link
Member

Description of Change

This adds all the missing API docs for the Maps project. Additionally this enables build errors when public XML docs are not found where they should be in order to prevent future documentation from being forgotten.

Issues Fixed

Related to #3960

@jfversluis jfversluis added area/docs 📓 Conceptual docs, API docs, Samples t/housekeeping ♻︎ area/Maps🗺 This issue has to do with .NET MAUI Maps labels Feb 28, 2024
@jfversluis jfversluis requested a review from a team as a code owner February 28, 2024 12:53
Copy link
Contributor

@jknaudt21 jknaudt21 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some docs for the boolean properties should follow the more standard wording "Gets or sets a value that indicates ...".
More info: https://github.com/dotnet/dotnet-api-docs/wiki/Summary%3A-Property

Other than that lgtm.

src/Controls/Maps/src/Map.cs Outdated Show resolved Hide resolved
src/Controls/Maps/src/Map.cs Outdated Show resolved Hide resolved
src/Controls/Maps/src/Map.cs Outdated Show resolved Hide resolved
src/Controls/Maps/src/Map.cs Outdated Show resolved Hide resolved
src/Controls/Maps/src/MapElement.cs Outdated Show resolved Hide resolved
src/Controls/Maps/src/Pin.cs Outdated Show resolved Hide resolved
src/Controls/Maps/src/Pin.cs Outdated Show resolved Hide resolved
src/Core/maps/src/Core/ICircleMapElement.cs Outdated Show resolved Hide resolved
@jfversluis jfversluis enabled auto-merge (squash) February 29, 2024 10:08
@jfversluis
Copy link
Member Author

/rebase

@jfversluis
Copy link
Member Author

Test failures unrelated

@jfversluis jfversluis merged commit dabab46 into main Mar 1, 2024
43 of 47 checks passed
@jfversluis jfversluis deleted the complete-maps-apidocs branch March 1, 2024 15:28
@github-actions github-actions bot locked and limited conversation to collaborators Apr 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/docs 📓 Conceptual docs, API docs, Samples area/Maps🗺 This issue has to do with .NET MAUI Maps t/housekeeping ♻︎
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants