fix errors

src/Microsoft.ComponentDetection.Common/AsyncExecution.cs

@@ -1,10 +1,24 @@
 namespace Microsoft.ComponentDetection.Common;
+
 using System;
 using System.Threading;
 using System.Threading.Tasks;
 
+/// <summary>
+/// Provides methods for executing code asynchronously with a timeout.
+/// </summary>
 public static class AsyncExecution
 {
+    /// <summary>
+    /// Executes the provided function asynchronously with a timeout.
+    /// </summary>
+    /// <param name="toExecute">The function to execute.</param>
+    /// <param name="timeout">The timeout.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
+    /// <typeparam name="T">The return type of the function.</typeparam>
+    /// <returns>The result of the function.</returns>
+    /// <exception cref="ArgumentNullException">Thrown when <paramref name="toExecute"/> is null.</exception>
+    /// <exception cref="TimeoutException">Thrown when the execution does not complete within the timeout.</exception>
     public static async Task<T> ExecuteWithTimeoutAsync<T>(Func<Task<T>> toExecute, TimeSpan timeout, CancellationToken cancellationToken)
     {
         if (toExecute == null)
@@ -17,12 +31,21 @@ public static async Task<T> ExecuteWithTimeoutAsync<T>(Func<Task<T>> toExecute,
         var completedInTime = await Task.Run(() => work.Wait(timeout));
         if (!completedInTime)
         {
-            throw new TimeoutException($"The execution did not complete in the alotted time ({timeout.TotalSeconds} seconds) and has been terminated prior to completion");
+            throw new TimeoutException($"The execution did not complete in the allotted time ({timeout.TotalSeconds} seconds) and has been terminated prior to completion");
         }
 
         return await work;
     }
 
+    /// <summary>
+    /// Executes the provided function asynchronously with a timeout.
+    /// </summary>
+    /// <param name="toExecute">The function to execute.</param>
+    /// <param name="timeout">The timeout.</param>
+    /// <param name="cancellationToken">The cancellation token.</param>
+    /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
+    /// <exception cref="ArgumentNullException">Thrown when <paramref name="toExecute"/> is null.</exception>
+    /// <exception cref="TimeoutException">Thrown when the execution does not complete within the timeout.</exception>
     public static async Task ExecuteVoidWithTimeoutAsync(Action toExecute, TimeSpan timeout, CancellationToken cancellationToken)
     {
         if (toExecute == null)
@@ -34,7 +57,7 @@ public static async Task ExecuteVoidWithTimeoutAsync(Action toExecute, TimeSpan
         var completedInTime = await Task.Run(() => work.Wait(timeout));
         if (!completedInTime)
         {
-            throw new TimeoutException($"The execution did not complete in the alotted time ({timeout.TotalSeconds} seconds) and has been terminated prior to completion");
+            throw new TimeoutException($"The execution did not complete in the allotted time ({timeout.TotalSeconds} seconds) and has been terminated prior to completion");
         }
     }
 }

src/Microsoft.ComponentDetection.Common/CommandLineInvocationService.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common;
+
 using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
@@ -10,10 +11,12 @@
 using Microsoft.ComponentDetection.Common.Telemetry.Records;
 using Microsoft.ComponentDetection.Contracts;
 
+/// <inheritdoc/>
 public class CommandLineInvocationService : ICommandLineInvocationService
 {
     private readonly IDictionary<string, string> commandLocatableCache = new ConcurrentDictionary<string, string>();
 
+    /// <inheritdoc/>
     public async Task<bool> CanCommandBeLocatedAsync(string command, IEnumerable<string> additionalCandidateCommands = null, DirectoryInfo workingDirectory = null, params string[] parameters)
     {
         additionalCandidateCommands ??= Enumerable.Empty<string>();
@@ -48,6 +51,7 @@ public async Task<bool> CanCommandBeLocatedAsync(string command, IEnumerable<str
         return !string.IsNullOrWhiteSpace(validCommand);
     }
 
+    /// <inheritdoc/>
     public async Task<CommandLineExecutionResult> ExecuteCommandAsync(string command, IEnumerable<string> additionalCandidateCommands = null, DirectoryInfo workingDirectory = null, params string[] parameters)
     {
         var isCommandLocatable = await this.CanCommandBeLocatedAsync(command, additionalCandidateCommands);
@@ -80,16 +84,19 @@ public async Task<CommandLineExecutionResult> ExecuteCommandAsync(string command
         }
     }
 
+    /// <inheritdoc/>
     public bool IsCommandLineExecution()
     {
         return true;
     }
 
+    /// <inheritdoc/>
     public async Task<bool> CanCommandBeLocatedAsync(string command, IEnumerable<string> additionalCandidateCommands = null, params string[] parameters)
     {
         return await this.CanCommandBeLocatedAsync(command, additionalCandidateCommands, workingDirectory: null, parameters);
     }
 
+    /// <inheritdoc/>
     public async Task<CommandLineExecutionResult> ExecuteCommandAsync(string command, IEnumerable<string> additionalCandidateCommands = null, params string[] parameters)
     {
         return await this.ExecuteCommandAsync(command, additionalCandidateCommands, workingDirectory: null, parameters);

src/Microsoft.ComponentDetection.Common/ComponentComparer.cs

@@ -1,14 +1,29 @@
 namespace Microsoft.ComponentDetection.Common;
+
 using System.Collections.Generic;
 using Microsoft.ComponentDetection.Contracts.TypedComponent;
 
+/// <summary>
+/// Compares two <see cref="TypedComponent"/>s by their <see cref="TypedComponent.Id"/>.
+/// </summary>
 public class ComponentComparer : EqualityComparer<TypedComponent>
 {
+    /// <summary>
+    /// Determines whether the specified objects are equal.
+    /// </summary>
+    /// <param name="x">The first object of type <see cref="TypedComponent"/> to compare.</param>
+    /// <param name="y">The second object of type <see cref="TypedComponent"/> to compare.</param>
+    /// <returns>true if the specified objects are equal; otherwise, false.</returns>
     public override bool Equals(TypedComponent x, TypedComponent y)
     {
         return x.Id.Equals(y.Id);
     }
 
+    /// <summary>
+    /// Returns a hash code for the specified object.
+    /// </summary>
+    /// <param name="obj">The <see cref="TypedComponent"/> for which a hash code is to be returned.</param>
+    /// <returns>A hash code for the specified object.</returns>
     public override int GetHashCode(TypedComponent obj)
     {
         return obj.Id.GetHashCode();

src/Microsoft.ComponentDetection.Common/ComponentStream.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common;
+
 using System.IO;
 using Microsoft.ComponentDetection.Contracts;
 

src/Microsoft.ComponentDetection.Common/ConsoleWritingService.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common;
+
 using System;
 
 public class ConsoleWritingService : IConsoleWritingService

src/Microsoft.ComponentDetection.Common/DependencyScopeComparer.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common;
+
 using Microsoft.ComponentDetection.Contracts.BcdeModels;
 
 /// <summary>

src/Microsoft.ComponentDetection.Common/DirectoryItemFacade.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common;
+
 using System.Collections.Generic;
 using System.Diagnostics;
 using Microsoft.ComponentDetection.Contracts;

src/Microsoft.ComponentDetection.Common/DockerReference/DigestUtility.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common;
+
 using System.Collections.Generic;
 
 public static class DigestUtility

src/Microsoft.ComponentDetection.Common/DockerReference/DockerReferenceException.cs

@@ -1,5 +1,6 @@
 #pragma warning disable SA1402
 namespace Microsoft.ComponentDetection.Common;
+
 using System;
 
 public class DockerReferenceException : Exception

src/Microsoft.ComponentDetection.Common/DockerReference/DockerReferenceUtility.cs

@@ -25,6 +25,7 @@
 // identifier                      := /[a-f0-9]{64}/
 // short-identifier                := /[a-f0-9]{6,64}/
 namespace Microsoft.ComponentDetection.Common;
+
 using Microsoft.ComponentDetection.Contracts;
 
 public static class DockerReferenceUtility

src/Microsoft.ComponentDetection.Common/DockerReference/DockerRegex.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common;
+
 using System.Linq;
 using System.Text.RegularExpressions;
 

src/Microsoft.ComponentDetection.Common/EnvironmentVariableService.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common;
+
 using System;
 using System.Linq;
 using Microsoft.ComponentDetection.Contracts;

src/Microsoft.ComponentDetection.Common/Exceptions/InvalidUserInputException.cs

@@ -1,17 +1,33 @@
 namespace Microsoft.ComponentDetection.Common.Exceptions;
+
 using System;
 
+/// <summary>
+/// Exception thrown when the user input is invalid.
+/// </summary>
 public class InvalidUserInputException : Exception
 {
+    /// <summary>
+    /// Initializes a new instance of the <see cref="InvalidUserInputException"/> class.
+    /// </summary>
+    /// <param name="message">The message that describes the error.</param>
+    /// <param name="innerException">The exception that is the cause of the current exception.</param>
     public InvalidUserInputException(string message, Exception innerException)
         : base(message, innerException)
     {
     }
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="InvalidUserInputException"/> class.
+    /// </summary>
     public InvalidUserInputException()
     {
     }
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="InvalidUserInputException"/> class.
+    /// </summary>
+    /// <param name="message">The message that describes the error.</param>
     public InvalidUserInputException(string message)
         : base(message)
     {

src/Microsoft.ComponentDetection.Common/FileUtilityService.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common;
+
 using System.IO;
 using Microsoft.ComponentDetection.Contracts;
 

src/Microsoft.ComponentDetection.Common/ISafeFileEnumerableFactory.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common;
+
 using System.Collections.Generic;
 using System.IO;
 using Microsoft.ComponentDetection.Contracts;

src/Microsoft.ComponentDetection.Common/MatchedFile.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common;
+
 using System.IO;
 
 public class MatchedFile

src/Microsoft.ComponentDetection.Common/PatternMatchingUtility.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common;
+
 using System;
 using System.Collections.Generic;
 using System.Linq;

src/Microsoft.ComponentDetection.Common/TabularStringFormat.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common;
+
 using System;
 using System.Collections.Generic;
 using System.Linq;

src/Microsoft.ComponentDetection.Common/Telemetry/Attributes/MetricAttribute.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common.Telemetry.Attributes;
+
 using System;
 
 /// <summary>

src/Microsoft.ComponentDetection.Common/Telemetry/ITelemetryService.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common.Telemetry;
+
 using Microsoft.ComponentDetection.Common.Telemetry.Records;
 
 public interface ITelemetryService

src/Microsoft.ComponentDetection.Common/Telemetry/Records/BaseDetectionTelemetryRecord.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common.Telemetry.Records;
+
 using System;
 using System.Diagnostics;
 using Microsoft.ComponentDetection.Common.Telemetry.Attributes;

src/Microsoft.ComponentDetection.Common/Telemetry/Records/BcdeExecutionTelemetryRecord.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common.Telemetry.Records;
+
 using System;
 
 using System.Threading;

src/Microsoft.ComponentDetection.Common/Telemetry/Records/CommandLineInvocationTelemetryRecord.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common.Telemetry.Records;
+
 using System;
 using Microsoft.ComponentDetection.Contracts;
 

src/Microsoft.ComponentDetection.Common/Telemetry/Records/DetectedComponentScopeRecord.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common.Telemetry.Records;
+
 using System.Runtime.CompilerServices;
 
 public class DetectedComponentScopeRecord : BaseDetectionTelemetryRecord

src/Microsoft.ComponentDetection.Common/Telemetry/Records/IDetectionTelemetryRecord.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common.Telemetry.Records;
+
 using System;
 
 public interface IDetectionTelemetryRecord : IDisposable

src/Microsoft.ComponentDetection.Common/Telemetry/Records/NuGetProjectAssetsTelemetryRecord.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common.Telemetry.Records;
+
 using System;
 
 public class NuGetProjectAssetsTelemetryRecord : IDetectionTelemetryRecord, IDisposable

src/Microsoft.ComponentDetection.Common/Telemetry/Records/PypiFailureTelemetryRecord.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common.Telemetry.Records;
+
 using System.Net;
 
 public class PypiFailureTelemetryRecord : BaseDetectionTelemetryRecord

src/Microsoft.ComponentDetection.Common/Telemetry/Records/PypiRetryTelemetryRecord.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Common.Telemetry.Records;
+
 using System.Net;
 
 public class PypiRetryTelemetryRecord : BaseDetectionTelemetryRecord

src/Microsoft.ComponentDetection.Contracts/BcdeModels/ContainerDetails.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
+
 using System;
 using System.Collections.Generic;
 using Newtonsoft.Json;

src/Microsoft.ComponentDetection.Contracts/BcdeModels/DefaultGraphScanResult.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
+
 using Newtonsoft.Json;
 using Newtonsoft.Json.Serialization;
 

src/Microsoft.ComponentDetection.Contracts/BcdeModels/DependencyGraph.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
+
 using System.Collections.Generic;
 
 public class DependencyGraph : Dictionary<string, HashSet<string>>

src/Microsoft.ComponentDetection.Contracts/BcdeModels/DependencyGraphCollection.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
+
 using System.Collections.Generic;
 
 public class DependencyGraphCollection : Dictionary<string, DependencyGraphWithMetadata>

src/Microsoft.ComponentDetection.Contracts/BcdeModels/DependencyGraphWithMetadata.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
+
 using System.Collections.Generic;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Serialization;

src/Microsoft.ComponentDetection.Contracts/BcdeModels/Detector.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
+
 using System.Collections.Generic;
 using Microsoft.ComponentDetection.Contracts.TypedComponent;
 using Newtonsoft.Json;

src/Microsoft.ComponentDetection.Contracts/BcdeModels/LayerMappedLinuxComponents.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
+
 using System.Collections.Generic;
 using Microsoft.ComponentDetection.Contracts.TypedComponent;
 

src/Microsoft.ComponentDetection.Contracts/BcdeModels/ScanResult.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
+
 using System.Collections.Generic;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;

src/Microsoft.ComponentDetection.Contracts/BcdeModels/ScannedComponent.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
+
 using System.Collections.Generic;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;

src/Microsoft.ComponentDetection.Contracts/BcdeModels/TypedComponentConverter.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Contracts.BcdeModels;
+
 using System;
 using System.Collections.Generic;
 using Microsoft.ComponentDetection.Contracts.TypedComponent;

src/Microsoft.ComponentDetection.Contracts/DetectedComponent.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Contracts;
+
 using System.Collections.Generic;
 using System.Diagnostics;
 using Microsoft.ComponentDetection.Contracts.BcdeModels;

src/Microsoft.ComponentDetection.Contracts/ICommandLineInvocationService.cs

@@ -1,4 +1,5 @@
 namespace Microsoft.ComponentDetection.Contracts;
+
 using System.Collections.Generic;
 using System.IO;
 using System.Threading.Tasks;
@@ -54,6 +55,9 @@ public interface ICommandLineInvocationService
     Task<CommandLineExecutionResult> ExecuteCommandAsync(string command, IEnumerable<string> additionalCandidateCommands = null, params string[] parameters);
 }
 
+/// <summary>
+/// Represents the result of executing a command line command.
+/// </summary>
 public class CommandLineExecutionResult
 {
     /// <summary>