Docs: MudBadge/MudBreadcrumbs/MudButton: Added XML Documentation for Public Members

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: MudBadge/MudBreadcrumbs/MudButton: Added XML Documentation for Public Members #8776

Closed jperson2000 closed 3 weeks ago

jperson2000 commented 3 weeks ago

Description

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

MudBadge
BreadcrumbItem
MudBreadcrumbs
MudBreakpointProvider
MudButton
MudFab
MudIconButton

How Has This Been Tested?

This was tested by observing the XML documentation for examples, like this:

MudBadge

MudBreadcrumbs

MudBreakpointProvider

MudButton

MudFab

MudIconButton

Type of Changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[X] Documentation (fix or improvement to the website or code docs)

Checklist

[X] The PR is submitted to the correct branch (dev).
[X] My code follows the code style of this project.
[ ] I've added relevant tests.

jperson2000 commented 3 weeks ago

Ready to review @danielchalmers @henon @ScarletKuro @mckaragoz when you get time. I'm curious what kind of XML documentation you think works best for constructors? Thanks!

codecov[bot] commented 3 weeks ago

Codecov Report

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

Project coverage is 90.11%. Comparing base (28bc599) to head (2060fa3). Report is 112 commits behind head on dev.

Files	Patch %	Lines
src/MudBlazor/Components/Button/MudButton.razor.cs	94.11%	0 Missing and 1 partial :warning:
src/MudBlazor/Components/Button/MudFab.razor.cs	87.50%	0 Missing and 1 partial :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## dev #8776 +/- ## ========================================== + Coverage 89.82% 90.11% +0.28% ========================================== Files 412 421 +9 Lines 11878 12206 +328 Branches 2364 2407 +43 ========================================== + Hits 10670 10999 +329 + Misses 681 664 -17 - Partials 527 543 +16 ```

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

danielchalmers commented 3 weeks ago

Dunno if the code file is necessary, it's done in one file in Grid at least:

Pretty subjective though

jperson2000 commented 3 weeks ago

Dunno if the code file is necessary, it's done in one file in Grid at least:

https://github.com/MudBlazor/MudBlazor/tree/0202d90f708b0566b463949ea67ac67fb0128dfe/src/MudBlazor/Components/Grid

https://github.com/MudBlazor/MudBlazor/pull/8748/files

And MudRender

Pretty subjective though

Thanks, Daniel! Having the codebehind helps me add XML docs for the class itself, but I can revert if needed. I think @henon preferred the codebehind files.

henon commented 3 weeks ago

Thanks Jon!