Add documentation to all events and fix analyzer warnings

Author: Banane9

ComponentSelectorAdditions/ComponentResult.cs

@@ -86,7 +86,7 @@ public ComponentResult(CategoryNode<Type>? category, Type type, string? group)
         }
 
         /// <inheritdoc/>
-        public override bool Equals(object obj)
+        public override bool Equals(object? obj)
             => obj is ComponentResult otherResult && otherResult.Type == Type;
 
         /// <inheritdoc/>

ComponentSelectorAdditions/ComponentSelectorAdditions.csproj

@@ -10,7 +10,7 @@
     <PackageId>ComponentSelectorAdditions</PackageId>
     <Title>Component Selector Additions</Title>
     <Authors>Banane9</Authors>
-    <Version>0.9.0-beta</Version>
+    <Version>0.10.0-beta</Version>
     <Description>This MonkeyLoader mod for Resonite overhauls the Component Selector / Protoflux Node Selector to have a search, as well as favorites and recents categories.</Description>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageLicenseExpression>LGPL-3.0-or-later</PackageLicenseExpression>

ComponentSelectorAdditions/Events/BuildButtonEvent.cs

@@ -9,13 +9,49 @@
 
 namespace ComponentSelectorAdditions.Events
 {
+    /// <summary>
+    /// Abstract base class for button generation events.
+    /// </summary>
     public abstract class BuildButtonEvent : CancelableBuildUIEvent
     {
+        /// <summary>
+        /// Gets whether the target of the button being generated is
+        /// a direct <see cref="CategoryNode{T}.Elements">element</see>
+        /// of the current <see cref="RootCategory">root category</see>.
+        /// </summary>
         public bool IsDirectItem { get; }
+
+        /// <summary>
+        /// Gets the category that the target of the button belongs to, if available.
+        /// </summary>
         public CategoryNode<Type>? ItemCategory { get; }
+
+        /// <summary>
+        /// Gets the current root category of the <see cref="ComponentSelector">selector</see>
+        /// that the button is being generated for, if available.
+        /// </summary>
         public CategoryNode<Type>? RootCategory { get; }
+
+        /// <summary>
+        /// Gets the selector that the button is being generated for.
+        /// </summary>
         public ComponentSelector Selector { get; }
 
+        /// <summary>
+        /// Creates a new button generation event with the given data.
+        /// </summary>
+        /// <param name="selector">The selector that the button is being generated for.</param>
+        /// <param name="ui">The <see cref="UIBuilder"/> to use while generating extra UI elements.</param>
+        /// <param name="rootCategory">
+        /// The current root category of the <see cref="ComponentSelector">selector</see>
+        /// that the button is being generated for, if available.
+        /// </param>
+        /// <param name="itemCategory">The category that the target of the button belongs to, if available.</param>
+        /// <param name="isDirectItem">
+        /// Whether the target of the button being generated is
+        /// a direct <see cref="CategoryNode{T}.Elements">element</see>
+        /// of the current <see cref="RootCategory">root category</see>.
+        /// </param>
         protected BuildButtonEvent(ComponentSelector selector, UIBuilder ui, CategoryNode<Type>? rootCategory, CategoryNode<Type>? itemCategory, bool isDirectItem) : base(ui)
         {
             Selector = selector;

ComponentSelectorAdditions/Events/BuildCategoryButtonEvent.cs

@@ -8,6 +8,13 @@
 
 namespace ComponentSelectorAdditions.Events
 {
+    /// <summary>
+    /// Represents the event data for the Build Category Button Event.
+    /// </summary>
+    /// <remarks>
+    /// This is used to generate the button for opening a nested
+    /// <see cref="CategoryNode{T}">category</see> in a <see cref="ComponentSelector">selector</see>.
+    /// </remarks>
     public sealed class BuildCategoryButtonEvent : BuildButtonEvent
     {
         /// <inheritdoc/>

ComponentSelectorAdditions/Events/BuildComponentButtonEvent.cs

@@ -8,10 +8,23 @@
 
 namespace ComponentSelectorAdditions.Events
 {
+    /// <summary>
+    /// Represents the event data for the Build Component Button Event.
+    /// </summary>
+    /// <remarks>
+    /// This is used to generate the button to attach a concrete component,
+    /// or to open the custom generic selection page for open generics.
+    /// </remarks>
     public sealed class BuildComponentButtonEvent : BuildButtonEvent
     {
+        /// <summary>
+        /// Gets the component result that the button targets.
+        /// </summary>
         public ComponentResult Component { get; }
 
+        /// <summary>
+        /// Gets the current selector path.
+        /// </summary>
         public SelectorPath Path { get; }
 
         /// <inheritdoc/>

ComponentSelectorAdditions/Events/BuildCustomGenericBuilder.cs

@@ -11,13 +11,27 @@
 
 namespace ComponentSelectorAdditions.Events
 {
+    /// <summary>
+    /// Represents the event data for the Build Custom Generic Builder Event.
+    /// </summary>
+    /// <remarks>
+    /// This is used to generate the UI for picking custom generic arguments for generic components.
+    /// </remarks>
     public sealed class BuildCustomGenericBuilder : BuildUIEvent
     {
         internal readonly HashSet<Button> OtherAddedButtonsSet = new();
 
+        /// <summary>
+        /// Gets or sets whether a create custom type button has been added already during this event.
+        /// </summary>
+        /// <value><see langword="true"/> if a create custom type button has been added; otherwise, <see langword="false"/>.</value>
         [MemberNotNullWhen(true, nameof(CreateCustomTypeButton))]
         public bool AddsCreateCustomTypeButton => CreateCustomTypeButton is not null;
 
+        /// <summary>
+        /// Gets or sets whether the inputs for generic arguments have been added already during this event.
+        /// </summary>
+        /// <value><see langword="true"/> if the inputs for generic arguments have been added; otherwise, <see langword="false"/>.</value>
         public bool AddsGenericArgumentInputs { get; set; }
 
         /// <summary>
@@ -34,8 +48,19 @@ public sealed class BuildCustomGenericBuilder : BuildUIEvent
         /// </summary>
         public Button? CreateCustomTypeButton { get; set; }
 
+        /// <summary>
+        /// Gets the generic arguments that inputs need to be generated for.
+        /// </summary>
         public Type[] GenericArguments { get; }
+
+        /// <summary>
+        /// Gets the other buttons that have been added to the custom generic builder.
+        /// </summary>
         public IEnumerable<Button> OtherAddedButtons => OtherAddedButtonsSet.AsSafeEnumerable();
+
+        /// <summary>
+        /// Gets the selector that the custom generic builder is being build for.
+        /// </summary>
         public ComponentSelector Selector { get; }
 
         internal BuildCustomGenericBuilder(ComponentSelector selector, UIBuilder ui, Type component) : base(ui)
@@ -45,12 +70,27 @@ internal BuildCustomGenericBuilder(ComponentSelector selector, UIBuilder ui, Typ
             GenericArguments = component.GetGenericArguments();
         }
 
+        /// <summary>
+        /// Adds <see cref="OtherAddedButtons">another</see> button to the custom generic builder.
+        /// </summary>
+        /// <param name="button">The button to add.</param>
+        /// <returns><see langword="true"/> if it was newly added; otherwise, <see langword="false"/>.</returns>
         public bool AddOtherButton(Button button)
             => OtherAddedButtonsSet.Add(button);
 
+        /// <summary>
+        /// Determines whether <see cref="OtherAddedButtons">another</see> button is already part of the custom generic builder.
+        /// </summary>
+        /// <param name="button">The button to check for.</param>
+        /// <returns><see langword="true"/> if it was found; otherwise, <see langword="false"/>.</returns>
         public bool HasOtherButton(Button button)
             => OtherAddedButtonsSet.Contains(button);
 
+        /// <summary>
+        /// Removes <see cref="OtherAddedButtons">another</see> button from the custom generic builder.
+        /// </summary>
+        /// <param name="button">The button to remove.</param>
+        /// <returns><see langword="true"/> if it was found and removed; otherwise, <see langword="false"/>.</returns>
         public bool RemoveOtherButton(Button button)
             => OtherAddedButtonsSet.Remove(button);
     }

ComponentSelectorAdditions/Events/BuildGroupButtonEvent.cs

@@ -8,9 +8,22 @@
 
 namespace ComponentSelectorAdditions.Events
 {
+    /// <summary>
+    /// Represents the event data for the Build Group Button Event.
+    /// </summary>
+    /// <remarks>
+    /// This is used to generate the button to open a group of components.
+    /// </remarks>
     public sealed class BuildGroupButtonEvent : BuildButtonEvent
     {
+        /// <summary>
+        /// Gets the group identifier that the button targets.
+        /// </summary>
         public string Group { get; }
+
+        /// <summary>
+        /// Gets the group name that the button should show.
+        /// </summary>
         public string GroupName { get; }
 
         /// <inheritdoc/>

ComponentSelectorAdditions/Events/BuildSelectorEvent.cs

@@ -6,23 +6,54 @@
 
 namespace ComponentSelectorAdditions.Events
 {
+    /// <summary>
+    /// Abstract base class for Build Selector Events.
+    /// </summary>
     public abstract class BuildSelectorEvent : BuildUIEvent
     {
+        /// <summary>
+        /// Gets or sets whether a back button has been added already during this event.
+        /// </summary>
+        /// <value><see langword="true"/> if a back button has been added; otherwise, <see langword="false"/>.</value>
         public bool AddsBackButton { get; set; }
+
+        /// <summary>
+        /// Gets or sets whether a cancel button has been added already during this event.
+        /// </summary>
+        /// <value><see langword="true"/> if a cancel button has been added; otherwise, <see langword="false"/>.</value>
         public bool AddsCancelButton { get; set; }
 
+        /// <summary>
+        /// Gets or sets whether a <see cref="SearchBar">search bar</see> has been added already during this event.
+        /// </summary>
+        /// <value><see langword="true"/> if a search bar has been added; otherwise, <see langword="false"/>.</value>
         [MemberNotNullWhen(true, nameof(SearchBar))]
         public bool AddsSearchBar => SearchBar is not null;
 
+        /// <summary>
+        /// Gets or sets the search bar that has been added.
+        /// </summary>
         public SelectorSearchBar? SearchBar { get; set; }
+
+        /// <summary>
+        /// Gets the selector that is being build.
+        /// </summary>
         public ComponentSelector Selector { get; }
+
         internal Action<SelectorPath, bool>? SelectorUIChangedHandlers => SelectorUIChanged;
 
         internal BuildSelectorEvent(ComponentSelector selector, UIBuilder ui) : base(ui)
         {
             Selector = selector;
         }
 
+        /// <summary>
+        /// Fired when the selector UI is changed.<br/>
+        /// The <see langword="bool"/> determines, whether the back button should be shown.
+        /// </summary>
+        /// <remarks>
+        /// This allows UI generated from this event to respond to changes in the path or back button state.
+        /// </remarks>
         public event Action<SelectorPath, bool>? SelectorUIChanged;
     }
 }

ComponentSelectorAdditions/Events/BuildSelectorFooterEvent.cs

@@ -4,12 +4,23 @@
 namespace ComponentSelectorAdditions.Events
 {
     /// <summary>
-    /// Represents the event fired when a <see cref="ComponentSelector"/>'s footer is constructed.
+    /// Represents the event data for the Build Selector Footer Event.
     /// </summary>
+    /// <remarks>
+    /// Fired when a <see cref="ComponentSelector"/>'s footer is constructed.
+    /// </remarks>
     public sealed class BuildSelectorFooterEvent : BuildSelectorEvent
     {
+        /// <summary>
+        /// Gets whether a back button was already added in
+        /// the <see cref="BuildSelectorHeaderEvent">header</see>.
+        /// </summary>
         public bool HasBackButton { get; }
 
+        /// <summary>
+        /// Gets whether a cancel button was already added in
+        /// the <see cref="BuildSelectorHeaderEvent">header</see>.
+        /// </summary>
         public bool HasCancelButton { get; }
 
         internal BuildSelectorFooterEvent(ComponentSelector selector, UIBuilder ui, SelectorSearchBar? searchBar, bool hasBackButton, bool hasCancelButton)

ComponentSelectorAdditions/Events/BuildSelectorHeaderEvent.cs

@@ -3,6 +3,12 @@
 
 namespace ComponentSelectorAdditions.Events
 {
+    /// <summary>
+    /// Represents the event data for the Build Selector Footer Event.
+    /// </summary>
+    /// <remarks>
+    /// Fired when a <see cref="ComponentSelector"/>'s header is constructed.
+    /// </remarks>
     public sealed class BuildSelectorHeaderEvent : BuildSelectorEvent
     {
         /// <inheritdoc/>