feat(components): add XML summaries to all publicly visible members (#…

…162)

* chore: .editorconfig

* feat(components): add missing summaries

* refactor(components): adjust LabelPlacement namespace

* refactor(radio): update `Color` param summary to point the correct default value

* test: update `_Imports`

.editorconfig

@@ -17,6 +17,8 @@ insert_final_newline = false
 
 #### .NET Code Actions ####
 
+dotnet_diagnostic.IDE0130.severity = silent
+
 # Type members
 dotnet_hide_advanced_members = false
 dotnet_member_insertion_location = with_other_members_of_the_same_kind
@@ -217,7 +219,7 @@ dotnet_naming_rule.property_should_be_pascal_case.severity = warning
 dotnet_naming_rule.property_should_be_pascal_case.symbols = property
 dotnet_naming_rule.property_should_be_pascal_case.style = pascal_case
 
-dotnet_naming_rule.private_or_internal_field_should_be_camel_case_prefixed_with__.severity = warning
+dotnet_naming_rule.private_or_internal_field_should_be_camel_case_prefixed_with__.severity = silent
 dotnet_naming_rule.private_or_internal_field_should_be_camel_case_prefixed_with__.symbols = private_or_internal_field
 dotnet_naming_rule.private_or_internal_field_should_be_camel_case_prefixed_with__.style = camel_case_prefixed_with__
 

src/LumexUI/Common/Attributes/CompositionComponentAttribute.cs

@@ -1,28 +1,23 @@
-using System.Diagnostics.CodeAnalysis;
+// Copyright (c) LumexUI 2024
+// LumexUI licenses this file to you under the MIT license
+// See the license here https://github.com/LumexUI/lumexui/blob/main/LICENSE
+
+using System.Diagnostics.CodeAnalysis;
 
 namespace LumexUI.Common;
 
 /// <summary>
-/// Specifies that a class is a composition component and defines the type of the aggregator component.
+/// Specifies that a class is a composition component and associates it with an aggregator type.
 /// </summary>
 /// <remarks>
 /// This attribute is used to indicate that the decorated class is part of a composition and is aggregated by a specific type.
 /// </remarks>
-[AttributeUsage( AttributeTargets.Class )]
 [ExcludeFromCodeCoverage]
-public class CompositionComponentAttribute : Attribute
+[AttributeUsage( AttributeTargets.Class )]
+public class CompositionComponentAttribute( Type aggregatorType ) : Attribute
 {
-    /// <summary>
-    /// Gets the type of the aggregator component.
-    /// </summary>
-    public Type AggregatorType { get; }
-
-    /// <summary>
-    /// Initializes a new instance of the <see cref="CompositionComponentAttribute"/> class with the specified aggregator type.
-    /// </summary>
-    /// <param name="aggregatorType">The type of the aggregator component.</param>
-    public CompositionComponentAttribute( Type aggregatorType )
-    {
-        AggregatorType = aggregatorType;
-    }
+	/// <summary>
+	/// Gets the aggregator type associated with the composition component.
+	/// </summary>
+	public Type AggregatorType { get; } = aggregatorType;
 }

src/LumexUI/Common/Enums/AccordionVariant.cs

@@ -4,13 +4,28 @@
 
 namespace LumexUI.Common;
 
+/// <summary>
+/// Specifies the visual variants for the <see cref="LumexAccordion"/>.
+/// </summary>
 public enum AccordionVariant
 {
-    Light,
+	/// <summary>
+	/// A variant without any styling.
+	/// </summary>
+	Light,
 
-    Shadow,
+	/// <summary>
+	/// A variant with a shadow effect.
+	/// </summary>
+	Shadow,
 
-    Bordered,
+	/// <summary>
+	/// A variant with a visible border around the accordion.
+	/// </summary>
+	Bordered,
 
-    Splitted
-}
+	/// <summary>
+	/// A variant where sections are visually separated.
+	/// </summary>
+	Splitted
+}

src/LumexUI/Common/Enums/Align.cs

@@ -5,22 +5,22 @@
 namespace LumexUI.Common;
 
 /// <summary>
-/// Specifies the alignment options.
+/// Specifies alignment options of a component.
 /// </summary>
 public enum Align
 {
-    /// <summary>
-    /// Aligns the content to the start.
-    /// </summary>
-    Start,
+	/// <summary>
+	/// Alignment to the start.
+	/// </summary>
+	Start,
 
-    /// <summary>
-    /// Aligns the content to the center.
-    /// </summary>
-    Center,
+	/// <summary>
+	/// Alignment to the center.
+	/// </summary>
+	Center,
 
-    /// <summary>
-    /// Aligns the content to the end.
-    /// </summary>
-    End
-}
+	/// <summary>
+	/// Alignment to the end.
+	/// </summary>
+	End
+}

src/LumexUI/Common/Enums/ButtonType.cs

@@ -4,11 +4,23 @@
 
 namespace LumexUI.Common;
 
+/// <summary>
+/// Specifies the type of the <see cref="LumexButton"/>.
+/// </summary>
 public enum ButtonType
 {
+	/// <summary>
+	/// A standard button with no default behavior.
+	/// </summary>
 	Button,
 
-    Submit,
+	/// <summary>
+	/// A button that submits form data.
+	/// </summary>
+	Submit,
 
-    Reset
+	/// <summary>
+	/// A button that resets all form fields to their initial values.
+	/// </summary>
+	Reset
 }

src/LumexUI/Common/Enums/InputBehavior.cs

@@ -5,19 +5,17 @@
 namespace LumexUI.Common;
 
 /// <summary>
-/// Specifies when the input component updates its value and triggers validation.
+/// Specifies the behavior of an input field when handling user input.
 /// </summary>
 public enum InputBehavior
 {
-    /// <summary>
-    /// Updates the value and triggers validation 
-    /// on each input event (e.g., when the user types in the input field).
-    /// </summary>
-    OnInput,
+	/// <summary>
+	/// Triggers the input event as the user types.
+	/// </summary>
+	OnInput,
 
-    /// <summary>
-    /// Updates the value and triggers validation 
-    /// on change events (e.g., when the input field loses focus or the user presses enter).
-    /// </summary>
-    OnChange
+	/// <summary>
+	/// Triggers the input event only when the field loses focus or the value changes.
+	/// </summary>
+	OnChange
 }

src/LumexUI/Common/Enums/InputType.cs

@@ -7,55 +7,55 @@
 namespace LumexUI.Common;
 
 /// <summary>
-/// Specifies the different types of input elements.
+/// Specifies the type of the <see cref="LumexTextbox"/>.
 /// </summary>
 public enum InputType
 {
-    /// <summary>
-    /// A text input field.
-    /// </summary>
-    [Description( "text" )]
-    Text,
-
-    /// <summary>
-    /// A password input field.
-    /// </summary>
-    [Description( "password" )]
-    Password,
-
-    /// <summary>
-    /// An email input field.
-    /// </summary>
-    [Description( "email" )]
-    Email,
-
-    /// <summary>
-    /// A hidden input field.
-    /// </summary>
-    [Description( "hidden" )]
-    Hidden,
-
-    /// <summary>
-    /// A search input field.
-    /// </summary>
-    [Description( "search" )]
-    Search,
-
-    /// <summary>
-    /// A telephone input field.
-    /// </summary>
-    [Description( "tel" )]
-    Telephone,
-
-    /// <summary>
-    /// A URL input field.
-    /// </summary>
-    [Description( "url" )]
-    Url,
-
-    /// <summary>
-    /// A color input field.
-    /// </summary>
-    [Description( "color" )]
-    Color
+	/// <summary>
+	/// A single-line text input field.
+	/// </summary>
+	[Description( "text" )]
+	Text,
+
+	/// <summary>
+	/// A password input field that masks the entered characters.
+	/// </summary>
+	[Description( "password" )]
+	Password,
+
+	/// <summary>
+	/// An input field for email addresses with built-in validation.
+	/// </summary>
+	[Description( "email" )]
+	Email,
+
+	/// <summary>
+	/// A hidden input field that is not visible to the user.
+	/// </summary>
+	[Description( "hidden" )]
+	Hidden,
+
+	/// <summary>
+	/// A search input field optimized for search queries.
+	/// </summary>
+	[Description( "search" )]
+	Search,
+
+	/// <summary>
+	/// An input field for telephone numbers.
+	/// </summary>
+	[Description( "tel" )]
+	Telephone,
+
+	/// <summary>
+	/// An input field for entering a URL.
+	/// </summary>
+	[Description( "url" )]
+	Url,
+
+	/// <summary>
+	/// An input field for selecting a color.
+	/// </summary>
+	[Description( "color" )]
+	Color
 }

src/LumexUI/Common/Enums/InputVariant.cs

@@ -5,22 +5,23 @@
 namespace LumexUI.Common;
 
 /// <summary>
-/// Specifies the different variants for an input component.
+/// Specifies the visual variants for input field components, 
+/// such as <see cref="LumexTextbox"/>, <see cref="LumexSelect{TValue}"/>, and others.
 /// </summary>
 public enum InputVariant
 {
-    /// <summary>
-    /// A flat variant input.
-    /// </summary>
-    Flat,
+	/// <summary>
+	/// A variant with a subtle background.
+	/// </summary>
+	Flat,
 
-    /// <summary>
-    /// An outlined variant input.
-    /// </summary>
-    Outlined,
+	/// <summary>
+	/// A variant with an outlined border.
+	/// </summary>
+	Outlined,
 
-    /// <summary>
-    /// An underlined variant input.
-    /// </summary>
-    Underlined
-}
+	/// <summary>
+	/// A variant with an underline.
+	/// </summary>
+	Underlined
+}

src/LumexUI/Common/Enums/LabelPlacement.cs

@@ -1,17 +1,22 @@
-namespace LumexUI;
+// Copyright (c) LumexUI 2024
+// LumexUI licenses this file to you under the MIT license
+// See the license here https://github.com/LumexUI/lumexui/blob/main/LICENSE
+
+namespace LumexUI.Common;
 
 /// <summary>
-/// Specifies the placement options for the label of an input component.
+/// Specifies the placement options for label in input field components, 
+/// such as <see cref="LumexTextbox"/>, <see cref="LumexSelect{TValue}"/> and others.
 /// </summary>
 public enum LabelPlacement
 {
-    /// <summary>
-    /// Places the label inside the input component.
-    /// </summary>
-    Inside,
+	/// <summary>
+	/// The label is placed inside the input field.
+	/// </summary>
+	Inside,
 
-    /// <summary>
-    /// Places the label outside the input component.
-    /// </summary>
-    Outside
+	/// <summary>
+	/// The label is placed outside the input field.
+	/// </summary>
+	Outside
 }