Enhance Icon component docs and add enum metadata (#1232)

Improved documentation for Icon component and its parameters, including new sections for IconColor, IconSize, and IconName enums. Added XML comments and attributes ([AddedVersion], [DefaultValue], [Description]) to parameters and enum values for better API reference and IntelliSense support.

Author: gvreddy04

BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Icons/Icon_Doc_01_Documentation.razor

@@ -14,10 +14,22 @@
     <img src="@imageUrl" class="img-fluid" alt="@metaTitle" />
 </Section>
 
-<Section Class="p-0" Size="HeadingSize.H3" Name="Parameters" PageUrl="@pageUrl" Link="parameters">
+<Section Class="p-0" Size="HeadingSize.H3" Name="Icon Parameters" PageUrl="@pageUrl" Link="icon-parameters">
     <DocxTable TItem="Icon" DocType="DocType.Parameters" />
 </Section>
 
+<Section Class="p-0" Size="HeadingSize.H3" Name="IconColor Enum" PageUrl="@pageUrl" Link="icon-color-enum">
+    <DocxTable TItem="IconColor" DocType="DocType.Enum" />
+</Section>
+
+<Section Class="p-0" Size="HeadingSize.H3" Name="IconSize Enum" PageUrl="@pageUrl" Link="icon-size-enum">
+    <DocxTable TItem="IconSize" DocType="DocType.Enum" />
+</Section>
+
+<Section Class="p-0" Size="HeadingSize.H3" Name="IconName Enum" PageUrl="@pageUrl" Link="icon-name-enum">
+    <DocxTable TItem="IconName" DocType="DocType.Enum" />
+</Section>
+
 @code {
     private const string componentName = nameof(Icon);
     private const string pageUrl = DemoRouteConstants.Docs_URL_Icons;

blazorbootstrap/Components/Icon/Icon.razor.cs

@@ -14,38 +14,50 @@ public partial class Icon : BlazorBootstrapComponentBase
 
     /// <summary>
     /// Gets or sets the icon color.
-    /// </summary>
-    /// <remarks>
+    /// <para>
     /// Default value is <see cref="IconColor.None" />.
-    /// </remarks>
+    /// </para>
+    /// </summary>
+    [AddedVersion("1.9.0")]
+    [DefaultValue(IconColor.None)]
+    [Description("Gets or sets the icon color.")]
     [Parameter]
     public IconColor Color { get; set; } = IconColor.None;
 
     /// <summary>
     /// Gets or sets the custom icon name.
     /// Specify custom icons of your own, like `fontawesome`. Example: `fas fa-alarm-clock`.
+    /// <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 custom icon name. Specify custom icons of your own, like `fontawesome`. Example: `fas fa-alarm-clock`.")]
     [Parameter]
     public string? CustomIconName { get; set; }
 
     /// <summary>
     /// Gets or sets the icon name.
-    /// </summary>
-    /// <remarks>
+    /// <para>
     /// Default value is <see cref="IconName.None" />.
-    /// </remarks>
+    /// </para>
+    /// </summary>
+    [AddedVersion("1.0.0")]
+    [DefaultValue(IconName.None)]
+    [Description("Gets or sets the icon name.")]
     [Parameter]
     public IconName Name { get; set; } = IconName.None;
 
     /// <summary>
     /// Gets or sets the icon size.
-    /// </summary>
-    /// <remarks>
+    /// <para>
     /// Default value is <see cref="IconSize.None" />.
-    /// </remarks>
+    /// </para>
+    /// </summary>
+    [AddedVersion("1.0.0")]
+    [DefaultValue(IconSize.None)]
+    [Description("Gets or sets the icon size.")]
     [Parameter]
     public IconSize Size { get; set; } = IconSize.None;
 

blazorbootstrap/Enums/Color/IconColor.cs

@@ -2,16 +2,87 @@
 
 public enum IconColor
 {
+    /// <summary>
+    /// Indicates no color is applied. Default color is inherited from parent element.
+    /// </summary>
+    [AddedVersion("1.9.0")]
+    [Description("Indicates no color is applied. Default color is inherited from parent element.")]
     None,
+
+    /// <summary>
+    /// Indicates the icon should use the primary color.
+    /// </summary>
+    [AddedVersion("1.9.0")]
+    [Description("Indicates the icon should use the primary color.")]
     Primary,
+
+    /// <summary>
+    /// Indicates the icon should use the secondary color.
+    /// </summary>
+    [AddedVersion("1.9.0")]
+    [Description("Indicates the icon should use the secondary color.")]
     Secondary,
+
+    /// <summary>
+    /// Indicates the icon should use the success color.
+    /// </summary>
+    [AddedVersion("1.9.0")]
+    [Description("Indicates the icon should use the success color.")]
     Success,
+
+    /// <summary>
+    /// Indicates the icon should use the danger color.
+    /// </summary>
+    [AddedVersion("1.9.0")]
+    [Description("Indicates the icon should use the danger color.")]
     Danger,
+
+    /// <summary>
+    /// Indicates the icon should use the warning color.
+    /// </summary>
+    [AddedVersion("1.9.0")]
+    [Description("Indicates the icon should use the warning color.")]
     Warning,
+
+    /// <summary>
+    /// Indicates the icon should use the info color.
+    /// </summary>
+    [AddedVersion("1.9.0")]
+    [Description("Indicates the icon should use the info color.")]
     Info,
+
+    /// <summary>
+    /// Indicates the icon should use the light color.
+    /// </summary>
+    [AddedVersion("1.9.0")]
+    [Description("Indicates the icon should use the light color.")]
     Light,
+
+    /// <summary>
+    /// Indicates the icon should use the dark color.
+    /// </summary>
+    [AddedVersion("1.9.0")]
+    [Description("Indicates the icon should use the dark color.")]
     Dark,
+
+    /// <summary>
+    /// Indicates the icon should use the body color.
+    /// </summary>
+    [AddedVersion("1.9.0")]
+    [Description("Indicates the icon should use the body color.")]
     Body,
+
+    /// <summary>
+    /// Indicates the icon should use the muted color.
+    /// </summary>
+    [AddedVersion("1.9.0")]
+    [Description("Indicates the icon should use the muted color.")]
     Muted,
+
+    /// <summary>
+    /// Indicates the icon should use the white color.
+    /// </summary>
+    [AddedVersion("1.9.0")]
+    [Description("Indicates the icon should use the white color.")]
     White
 }

blazorbootstrap/Enums/IconSize.cs

@@ -5,35 +5,49 @@ public enum IconSize
     /// <summary>
     /// The default icon size.
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("")]
     None,
 
     /// <summary>
     /// An extra large icon, 2.5rem in size.
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("An extra large icon, 2.5rem in size.")]
     x1,
 
     /// <summary>
     /// A large icon, 2rem in size.
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("A large icon, 2rem in size.")]
     x2,
 
     /// <summary>
     /// A medium icon, 1.75rem in size.
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("A medium icon, 1.75rem in size.")]
     x3,
 
     /// <summary>
     /// A small icon, 1.5rem in size.
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("A small icon, 1.5rem in size.")]
     x4,
 
     /// <summary>
     /// A very small icon, 1.25rem in size.
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("A very small icon, 1.25rem in size.")]
     x5,
 
     /// <summary>
     /// The smallest icon, 1rem in size.
     /// </summary>
+    [AddedVersion("1.0.0")]
+    [Description("The smallest icon, 1rem in size.")]
     x6
 }