Enhance Ribbon API docs and add metadata attributes #1224
Merged
Conversation
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
Improve XML docs and add [AddedVersion], [DefaultValue], and [Description] attributes to Placeholder and PlaceholderContainer parameters. Remove redundant remarks and clarify default values. Add [ParameterTypeName] to ChildContent for better tooling and documentation support.
- Added Preload Service route constants and screenshot paths for demos and docs - Updated navigation menus to include Preload Service under Services - Added PreloadService documentation page with screenshot and methods table - Enhanced Preload component parameter documentation with version and default value attributes - Documented PreloadService Show/Hide methods with XML comments and attributes - Fixed DemoLink in BreadcrumbService documentation to correct target
Improved XML documentation and added metadata attributes ([AddedVersion], [DefaultValue], [Description], [ParameterTypeName]) to parameters and methods in Progress and ProgressBar components. Updated Label to nullable string. Adjusted documentation sections to better reflect available methods and parameters. These changes improve API clarity and tooling support.
Add detailed XML documentation and custom metadata attributes ([AddedVersion], [DefaultValue], [Description], [ParameterTypeName]) to Ribbon, RibbonTab, RibbonGroup, RibbonItem, RibbonItemGroup, and RibbonEventArgs. Update event and parameter docs, make ChildContent nullable and consistent, and improve discoverability in the documentation page. Improves API clarity and self-documentation.
Refactored PropertyInfoExtenstions to use Attribute.GetCustomAttribute for attribute retrieval, simplifying code. Added NullabilityInfoContext and GetFriendlyTypeName for accurate C# type name generation, including nullable and generic types. Updated GetParameterTypeName to use new logic. Renamed RibbonTab.razor.cs property ChildContent to Content.
Enhanced type name rendering in DocxPropertyRow to accurately display tuples, generics, nullable types, and object types. Updated extension methods and constants to ensure C#-idiomatic and user-friendly type names in the UI.
Refactored method and property type name extraction to use a new GetFriendlyTypeName extension based on NullabilityInfo, ensuring accurate C#-style type names (including nullability, generics, and tuples). Simplified method signature display in DocxMethodRow.razor. Removed legacy type name formatting logic and centralized type name handling in the new NullabilityInfoExtensions.cs. Attribute extraction now uses Attribute.GetCustomAttribute. These changes modernize and unify type name presentation across the documentation/demo UI.
Removed the [ParameterTypeName] attribute from several parameters in Accordion and AccordionItem classes. Parameters remain unchanged and still use [Parameter], but no longer include explicit type annotations via [ParameterTypeName].
Added a methods section to ConfirmDialog documentation and introduced three ShowAsync overloads with versioning and descriptions. Removed [ParameterTypeName(...)] from component parameters across multiple files for cleaner code and improved documentation. Simplified private field initializations in Button.razor.cs.
Eliminated all [ParameterTypeName(...)] attributes from Blazor component parameter declarations for cleaner code. Improved XML docs for some Ribbon and RibbonItemGroup parameters, and updated Ribbon's EnableFadeEffect parameter attributes for clarity and consistency. No changes to parameter properties themselves.
- Updated XML docs to clarify default values using <see langword="false"/> and <see langword="null"/>. - Enhanced [Description] attributes for all properties. - Made Name, Title, TitleTemplate, and Parent properties nullable. - Set [DefaultValue(false)] for Active and Disabled. - Removed redundant attributes ([ParameterTypeName], unnecessary [DefaultValue]). - Improved code readability, null-safety, and maintainability.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.