Enhance Sidebar2 API docs and add metadata attributes (#1226)

Improved XML comments with cref references and HTML formatting for clarity. Added [AddedVersion], [DefaultValue], and [Description] attributes to public properties and methods. Removed redundant remarks and [EditorRequired] from DataProvider. These changes make the Sidebar2 API more self-describing and tooling-friendly.

Author: gvreddy04

blazorbootstrap/Components/Sidebar2/Sidebar2.razor.cs

@@ -55,9 +55,11 @@ public void bsWindowResize(int width)
     }
 
     /// <summary>
-    /// Refresh the sidebar data.
+    /// Refresh the <see cref="Sidebar2"/> data.
     /// </summary>
     /// <returns>Task</returns>
+    [AddedVersion("2.1.0")]
+    [Description("Refresh the <b>Sidebar2</b> data.")]
     public async Task RefreshDataAsync(bool firstRender = false)
     {
         if (requestInProgress)
@@ -79,8 +81,10 @@ public async Task RefreshDataAsync(bool firstRender = false)
     }
 
     /// <summary>
-    /// Toggles sidebar.
+    /// Toggles <see cref="Sidebar2"/>.
     /// </summary>
+    [AddedVersion("2.1.0")]
+    [Description("Toggles <b>Sidebar2</b>.")]
     public void ToggleSidebar()
     {
         collapseSidebar = !collapseSidebar;
@@ -130,88 +134,124 @@ private string GetNavMenuCssClass()
     /// <summary>
     /// Gets or sets the badge text.
     /// </summary>
-    /// <remarks>
-    /// Default value is null.
-    /// </remarks>
+    /// <para>
+    /// Default value is <see langword="null"/>.
+    /// </para>
+    [AddedVersion("2.1.0")]
+    [DefaultValue(null)]
+    [Description("Gets or sets the badge text.")]
     [Parameter]
     public string? BadgeText { get; set; }
 
     /// <summary>
     /// Gets or sets the custom icon name.
     /// </summary>
-    /// <remarks>
-    /// Default value is null.
-    /// </remarks>
+    /// <para>
+    /// Default value is <see langword="null"/>.
+    /// </para>
+    [AddedVersion("2.1.0")]
+    [DefaultValue(null)]
+    [Description("Gets or sets the custom icon name.")]
     [Parameter]
     public string? CustomIconName { get; set; }
 
     /// <summary>
     /// Gets or sets the data provider.
     /// </summary>
-    /// <remarks>
-    /// Default value is null.
-    /// </remarks>
-    [Parameter]
+    /// <para>
+    /// Default value is <see langword="null"/>.
+    /// </para>
+    [AddedVersion("2.1.0")]
+    [DefaultValue(null)]
+    [Description("Gets or sets the data provider.")]
     [EditorRequired]
-    public Sidebar2DataProviderDelegate? DataProvider { get; set; } = default!;
+    [Parameter]
+    public Sidebar2DataProviderDelegate? DataProvider { get; set; }
 
     /// <summary>
     /// Gets or sets the Href.
     /// </summary>
-    /// <remarks>
+    /// <para>
     /// Default value is <see cref="string.Empty" />.
-    /// </remarks>
+    /// </para>
+    [AddedVersion("3.0.0")]
+    [DefaultValue("Empty string")]
+    [Description("Gets or sets the Href.")]
     [Parameter]
     public string? Href { get; set; } = string.Empty;
 
     /// <summary>
     /// Gets or sets the IconName.
     /// </summary>
-    /// <remarks>
+    /// <para>
     /// Default value is <see cref="IconName.None" />.
-    /// </remarks>
+    /// </para>
+    [AddedVersion("2.1.0")]
+    [DefaultValue(IconName.None)]
+    [Description("Gets or sets the IconName.")]
     [Parameter]
     public IconName IconName { get; set; }
 
     /// <summary>
-    /// Gets or sets the sidebar logo.
+    /// Gets or sets the <see cref="Sidebar2"/> logo.
     /// </summary>
-    /// <remarks>
-    /// Default value is null.
-    /// </remarks>
+    /// <para>
+    /// Default value is <see langword="null"/>.
+    /// </para>
+    [AddedVersion("2.1.0")]
+    [DefaultValue(null)]
+    [Description("Gets or sets the <b>Sidebar2</b> logo.")]
     [Parameter]
     public string? ImageSrc { get; set; }
 
     /// <summary>
     /// Gets or sets the width of the image in pixels.
     /// You can change the unit by setting <see cref="WidthUnit" />.
-    /// <remarks>Default value is 0.</remarks>
+    /// <para>
+    /// Default value is 0.
+    /// </para>
     /// </summary>
+    [AddedVersion("3.4.0")]
+    [DefaultValue(0)]
+    [Description("Gets or sets the width of the image in pixels. You can change the unit by setting <b>WidthUnit</b>.")]
     [Parameter]
     public float ImageWidth { get; set; } = 0;
 
     private string? navMenuCssClass => GetNavMenuCssClass();
 
     /// <summary>
-    /// Gets or sets the sidebar title.
+    /// Gets or sets the <see cref="Sidebar2"/> title.
     /// </summary>
-    /// <remarks>
-    /// Default value is null.
-    /// </remarks>
+    /// <para>
+    /// Default value is <see langword="null"/>.
+    /// </para>
+    [AddedVersion("2.1.0")]
+    [DefaultValue(null)]
+    [Description("Gets or sets the <b>Sidebar2</b> title.")]
     [Parameter]
-    public string? Title { get; set; } = default!;
+    public string? Title { get; set; }
 
     /// <summary>
-    /// Gets or sets the sidebar width.
+    /// Gets or sets the <see cref="Sidebar2"/> width.
     /// </summary>
-    /// <remarks>Default value is 270.</remarks>
+    /// <para>
+    /// Default value is 270.
+    /// </para>
+    [AddedVersion("3.0.0")]
+    [DefaultValue(270)]
+    [Description("Gets or sets the <b>Sidebar2</b> width.")]
     [Parameter]
     public float Width { get; set; } = 270;
 
     /// <summary>
-    /// Gets or sets the sidebar width unit.
+    /// Gets or sets the <see cref="Sidebar2"/> width unit.
     /// </summary>
-    /// <remarks>Default value is <see cref="Unit.Px" />.</remarks>
+    /// <para>
+    /// Default value is <see cref="Unit.Px" />.
+    /// </para>
+    [AddedVersion("3.0.0")]
+    [DefaultValue(Unit.Px)]
+    [Description("Gets or sets the <b>Sidebar2</b> width unit.")]
     [Parameter]
     public Unit WidthUnit { get; set; } = Unit.Px;