Enhance Toasts docs and add API metadata attributes (#1230)

Improved XML documentation and added [AddedVersion], [DefaultValue], and [Description] attributes to Toasts components, enums, and related classes. Updated documentation pages to include enum details. These changes improve API discoverability and support for documentation tooling.

Author: gvreddy04

BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Toasts/Toasts_Doc_01_Documentation.razor

@@ -18,10 +18,18 @@
     <DocxTable TItem="Toasts" DocType="DocType.Parameters" />
 </Section>
 
+<Section Class="p-0" Size="HeadingSize.H3" Name="ToastsPlacement Enum" PageUrl="@pageUrl" Link="toasts-placement-enum">
+    <DocxTable TItem="ToastsPlacement" DocType="DocType.Enum" />
+</Section>
+
 <Section Class="p-0" Size="HeadingSize.H3" Name="ToastMessage Properties" PageUrl="@pageUrl" Link="toast-message-properties">
     <DocxTable TItem="ToastMessage" DocType="DocType.Properties" />
 </Section>
 
+<Section Class="p-0" Size="HeadingSize.H3" Name="ToastType Enum" PageUrl="@pageUrl" Link="toast-type-enum">
+    <DocxTable TItem="ToastType" DocType="DocType.Enum" />
+</Section>
+
 @code {
     private const string componentName = nameof(Toasts);
     private const string pageUrl = DemoRouteConstants.Docs_URL_Toasts;

blazorbootstrap/Components/ThemeSwitcher/ThemeSwitcher.razor.cs

@@ -53,19 +53,25 @@ public async Task OnThemeChangedJS(string themeName)
     /// <summary>
     /// Fired when the theme is changed.
     /// </summary>
+    [AddedVersion("3.2.0")]
+    [Description("Fired when the theme is changed.")]
     [Parameter]
     public EventCallback<string> OnThemeChanged { get; set; }
 
     /// <summary>
     /// Gets or sets the dropdown menu position.
-    /// </summary>
-    /// <remarks>
+    /// <para>
     /// Default value is <see cref="DropdownMenuPosition.Start" />.
-    /// </remarks>
+    /// </para>
+    /// </summary>
+    [AddedVersion("3.2.0")]
+    [DefaultValue(DropdownMenuPosition.Start)]
+    [Description("Gets or sets the dropdown menu position.")]
     [Parameter]
     public DropdownMenuPosition Position { get; set; } = DropdownMenuPosition.Start;
 
-    [Inject] private ThemeSwitcherJsInterop ThemeSwitcherJsInterop { get; set; } = default!;
+    [Inject] 
+    private ThemeSwitcherJsInterop ThemeSwitcherJsInterop { get; set; } = default!;
 
     #endregion
 }

blazorbootstrap/Components/Toasts/SimpleToast.razor.cs

@@ -71,21 +71,21 @@ protected override async Task OnInitializedAsync()
 
     /// <summary>
     /// Gets or sets the auto hide state.
+    /// <para>
+    /// Default value is <see langword="true"/>.
+    /// </para>
     /// </summary>
-    /// <remarks>
-    /// Default value is true.
-    /// </remarks>
     [Parameter]
     public bool AutoHide { get; set; } = true;
 
     private string CloseButtonClass => $"btn-close-{ToastMessage!.Type.ToToastTextColorClass()}";
 
     /// <summary>
     /// Gets or sets the delay in milliseconds before hiding the toast.
-    /// </summary>
-    /// <remarks>
+    /// <para>
     /// Default value is 5000.
-    /// </remarks>
+    /// </para>
+    /// </summary>
     [Parameter]
     public int Delay { get; set; } = 5000;
 
@@ -103,10 +103,10 @@ protected override async Task OnInitializedAsync()
 
     /// <summary>
     /// If <see langword="true" />, shows the close button.
+    /// <para>
+    /// Default value is <see langword="true"/>.
+    /// </para>
     /// </summary>
-    /// <remarks>
-    /// Default value is true.
-    /// </remarks>
     [Parameter]
     public bool ShowCloseButton { get; set; } = true;
 
@@ -124,10 +124,10 @@ protected override async Task OnInitializedAsync()
 
     /// <summary>
     /// Gets or sets the toast message.
+    /// <para>
+    /// Default value is <see langword="null"/>.
+    /// </para>
     /// </summary>
-    /// <remarks>
-    /// Default value is null.
-    /// </remarks>
     [Parameter]
     public ToastMessage? ToastMessage { get; set; }
 

blazorbootstrap/Components/Toasts/Toast.razor.cs

@@ -153,19 +153,19 @@ private IconName GetToastIconName() =>
 
     /// <summary>
     /// Gets or sets the auto hide state.
+    /// <para>
+    /// Default value is <see langword="false"/>.
+    /// </para>
     /// </summary>
-    /// <remarks>
-    /// Default value is false.
-    /// </remarks>
     [Parameter]
     public bool AutoHide { get; set; }
 
     /// <summary>
     /// Gets or sets the delay in milliseconds before hiding the toast.
-    /// </summary>
-    /// <remarks>
+    /// <para>
     /// Default value is 5000.
-    /// </remarks>
+    /// </para>
+    /// </summary>
     [Parameter]
     public int Delay { get; set; } = 5000;
 
@@ -189,10 +189,10 @@ private IconName GetToastIconName() =>
 
     /// <summary>
     /// If <see langword="true" />, shows the close button.
+    /// <para>
+    /// Default value is <see langword="true"/>.
+    /// </para>
     /// </summary>
-    /// <remarks>
-    /// Default value is true.
-    /// </remarks>
     [Parameter]
     public bool ShowCloseButton { get; set; } = true;
 
@@ -210,10 +210,10 @@ private IconName GetToastIconName() =>
 
     /// <summary>
     /// Gets or sets the toast message.
+    /// <para>
+    /// Default value is <see langword="null"/>.
+    /// </para>
     /// </summary>
-    /// <remarks>
-    /// Default value is null.
-    /// </remarks>
     [Parameter]
     public ToastMessage ToastMessage { get; set; } = default!;
 

blazorbootstrap/Components/Toasts/Toasts.razor.cs

@@ -90,59 +90,78 @@ private async Task OnToastShownAsync(ToastEventArgs args)
 
     /// <summary>
     /// Gets or sets the auto hide state.
+    /// <para>
+    /// Default value is <see langword="false"/>.
+    /// </para>
     /// </summary>
-    /// <remarks>
-    /// Default value is false.
-    /// </remarks>
+    [AddedVersion("1.0.0")]
+    [DefaultValue(false)]
+    [Description("Gets or sets the auto hide state.")]
     [Parameter]
     public bool AutoHide { get; set; }
 
     /// <summary>
     /// Gets or sets the delay in milliseconds before hiding the toast.
-    /// </summary>
-    /// <remarks>
+    /// <para>
     /// Default value is 5000.
-    /// </remarks>
+    /// </para>
+    /// </summary>
+    [AddedVersion("1.0.0")]
+    [DefaultValue(5000)]
+    [Description("Gets or sets the delay in milliseconds before hiding the toast.")]
     [Parameter]
     public int Delay { get; set; } = 5000;
 
     /// <summary>
     /// Gets or sets the toast messages.
+    /// <para>
+    /// Default value is <see langword="null"/>.
+    /// </para>
     /// </summary>
-    /// <remarks>
-    /// Default value is null.
-    /// </remarks>
+    [AddedVersion("1.0.0")]
+    [DefaultValue(null)]
+    [Description("Gets or sets the toast messages.")]
     [Parameter]
-    public List<ToastMessage>? Messages { get; set; } = default!;
+    public List<ToastMessage>? Messages { get; set; }
 
     /// <summary>
     /// Gets or sets the toast placement.
-    /// </summary>
-    /// <remarks>
+    /// <para>
     /// Default value is <see cref="ToastsPlacement.TopRight" />.
-    /// </remarks>
+    /// </para>
+    /// </summary>
+    [AddedVersion("1.0.0")]
+    [DefaultValue(ToastsPlacement.TopRight)]
+    [Description("Gets or sets the toast placement.")]
     [Parameter]
     public ToastsPlacement Placement { get; set; } = ToastsPlacement.TopRight;
 
     /// <summary>
     /// If <see langword="true" />, shows the close button.
+    /// <para>
+    /// Default value is <see langword="true"/>.
+    /// </para>
     /// </summary>
-    /// <remarks>
-    /// Default value is true.
-    /// </remarks>
+    [AddedVersion("1.0.0")]
+    [DefaultValue(true)]
+    [Description("If <b>true</b>, shows the close button.")]
     [Parameter]
     public bool ShowCloseButton { get; set; } = true;
 
     /// <summary>
     /// Gets or sets the toast container maximum capacity.
-    /// </summary>
-    /// <remarks>
+    /// <para>
     /// Default value is 5.
-    /// </remarks>
+    /// </para>
+    /// </summary>
+    [AddedVersion("1.0.0")]
+    [DefaultValue(5)]
+    [Description("Gets or sets the toast container maximum capacity.")]
     [Parameter]
     public int StackLength { get; set; } = 5;
 
-    [Inject] public ToastService ToastService { get; set; } = default!;
+    [Inject] 
+    public ToastService ToastService { get; set; } = default!;
 
     #endregion
 }

blazorbootstrap/Enums/ToastType.cs

@@ -3,43 +3,59 @@
 public enum ToastType
 {
     /// <summary>
-    /// Primary background color.
+    /// Sets the primary background color to the toast.
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Sets the primary background color to the toast.")]
     Primary = 1,
 
     /// <summary>
-    /// Secondary background color.
+    /// Sets the secondary background color to the toast.
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Sets the secondary background color to the toast.")]
     Secondary,
 
     /// <summary>
-    /// Success background color.
+    /// Sets the success background color to the toast.
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Sets the success background color to the toast.")]
     Success,
 
     /// <summary>
-    /// Danger background color.
+    /// Sets the danger background color to the toast.
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Sets the danger background color to the toast.")]
     Danger,
 
     /// <summary>
-    /// Warning background color.
+    /// Sets the warning background color to the toast.
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Sets the warning background color to the toast.")]
     Warning,
 
     /// <summary>
-    /// Info background color.
+    /// Sets the info background color to the toast.
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Sets the info background color to the toast.")]
     Info,
 
     /// <summary>
-    /// Light background color.
+    /// Sets the light background color to the toast.
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Sets the light background color to the toast.")]
     Light,
 
     /// <summary>
-    /// Dark background color.
+    /// Sets the dark background color to the toast.
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Sets the dark background color to the toast.")]
     Dark
 
     // TODO: Review

blazorbootstrap/Enums/ToastsPlacement.cs

@@ -7,40 +7,56 @@ public enum ToastsPlacement
     /// <summary>
     /// Top center
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Top center")]
     TopCenter,
 
     /// <summary>
     /// Top right
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Top right")]
     TopRight,
 
     /// <summary>
     /// Middle left
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Middle left")]
     MiddleLeft,
 
     /// <summary>
     /// Middle center
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Middle center")]
     MiddleCenter,
 
     /// <summary>
     /// Middle right
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Middle right")]
     MiddleRight,
 
     /// <summary>
     /// Bottom left
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Bottom left")]
     BottomLeft,
 
     /// <summary>
     /// Bottom center
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Bottom center")]
     BottomCenter,
 
     /// <summary>
     /// Bottom right
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("Bottom right")]
     BottomRight
 }