MudBlazor / MudBlazor

Blazor Component Library based on Material design with an emphasis on ease of use. Mainly written in C# with Javascript kept to a bare minimum it empowers .NET developers to easily debug it if needed.
http://mudblazor.com
MIT License
7.21k stars 1.18k forks source link

Docs: MudButtonGroup/MudCard/MudCarousel/MudChart: Added XML Documentation for Public Members #8810

Closed jperson2000 closed 2 weeks ago

jperson2000 commented 2 weeks ago

Description

This update adds XML documentation for the following components and classes, for all public members:

This update also adds one code change: a small optimization to MudChart.razor where the ChartType does not have to be evaluated multiple times.

Finally, this update corrects a minor typo on the CarouselExample.razor example, changing "Enable Swap Gesture" to "Enable Swipe Gesture"

How Has This Been Tested?

This was tested by observing the XML documentation while working with examples:

MudButtonGroup

image image

MudCard

image image image image image image

MudCarousel

image image image image

MudChart

image image image image image image image

Type of Changes

Checklist

codecov[bot] commented 2 weeks ago

Codecov Report

Attention: Patch coverage is 97.10145% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 90.11%. Comparing base (28bc599) to head (0daa5be). Report is 119 commits behind head on dev.

Files Patch % Lines
...MudBlazor/Components/Carousel/MudCarousel.razor.cs 91.66% 0 Missing and 1 partial :warning:
...lazor/Components/Carousel/MudCarouselItem.razor.cs 94.44% 0 Missing and 1 partial :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev #8810 +/- ## ========================================== + Coverage 89.82% 90.11% +0.28% ========================================== Files 412 421 +9 Lines 11878 12216 +338 Branches 2364 2409 +45 ========================================== + Hits 10670 11009 +339 + Misses 681 665 -16 - Partials 527 542 +15 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

jperson2000 commented 2 weeks ago

Hi there @henon @danielchalmers @mikes-gh ! Here's another round of XML documentation updates as we work our way from A-Z. This PR does have one small code change: an optimization in MudChart.razor where ChartType only needs to be checked once (instead of five times) to determine the chart component to show, but let me know if you'd like that rolled back to keep this a docs-only PR.

henon commented 2 weeks ago

Thanks!