Enhance classes XML documentation

Author: willibrandon

src/NetContextClient/Models/AddIgnorePatternsResponse.cs

@@ -5,7 +5,13 @@ namespace NetContextClient.Models;
 /// </summary>
 public class AddIgnorePatternsResponse : IgnorePatternsResponse
 {
+    /// <summary>
+    /// Gets or sets the array of glob patterns that were successfully added to the ignore list.
+    /// </summary>
     public string[] ValidPatternsAdded { get; set; } = [];
 
+    /// <summary>
+    /// Gets or sets the array of patterns that were rejected due to invalid glob syntax or other validation errors.
+    /// </summary>
     public string[] InvalidPatterns { get; set; } = [];
 } 

src/NetContextClient/Models/IgnorePatternsResponse.cs

@@ -5,9 +5,18 @@ namespace NetContextClient.Models;
 /// </summary>
 public class IgnorePatternsResponse
 {
+    /// <summary>
+    /// Gets or sets the built-in default glob patterns used for file exclusion.
+    /// </summary>
     public string[] DefaultPatterns { get; set; } = [];
 
+    /// <summary>
+    /// Gets or sets the user-defined glob patterns used for file exclusion.
+    /// </summary>
     public string[] UserPatterns { get; set; } = [];
 
+    /// <summary>
+    /// Gets or sets the combined list of both default and user-defined glob patterns.
+    /// </summary>
     public string[] AllPatterns { get; set; } = [];
 } 

src/NetContextClient/Models/PackageAnalysis.cs

@@ -5,21 +5,48 @@ namespace NetContextClient.Models;
 /// </summary>
 public class PackageAnalysis
 {
+    /// <summary>
+    /// Gets or sets the NuGet package identifier.
+    /// </summary>
     public string PackageId { get; set; } = "";
 
+    /// <summary>
+    /// Gets or sets the current version of the package installed in the project.
+    /// </summary>
     public string Version { get; set; } = "";
 
+    /// <summary>
+    /// Gets or sets a value indicating whether the package is actively used in the project.
+    /// </summary>
     public bool IsUsed { get; set; }
 
+    /// <summary>
+    /// Gets or sets the list of file paths where the package is referenced or used.
+    /// </summary>
     public List<string> UsageLocations { get; set; } = [];
 
+    /// <summary>
+    /// Gets or sets the latest available version of the package, if an update is available.
+    /// </summary>
     public string? LatestVersion { get; set; }
 
+    /// <summary>
+    /// Gets or sets a value indicating whether the package has known security vulnerabilities.
+    /// </summary>
     public bool HasSecurityIssues { get; set; }
 
+    /// <summary>
+    /// Gets or sets the recommended action to take regarding this package (e.g., update, remove, etc.).
+    /// </summary>
     public string? RecommendedAction { get; set; }
 
+    /// <summary>
+    /// Gets or sets a value indicating whether a newer version of the package is available.
+    /// </summary>
     public bool HasUpdate { get; set; }
 
+    /// <summary>
+    /// Gets or sets the list of packages that depend on this package.
+    /// </summary>
     public List<string> TransitiveDependencies { get; set; } = [];
 } 

src/NetContextClient/Models/ProjectPackageAnalysis.cs

@@ -5,7 +5,13 @@ namespace NetContextClient.Models;
 /// </summary>
 public class ProjectPackageAnalysis
 {
+    /// <summary>
+    /// Gets or sets the path to the project file being analyzed.
+    /// </summary>
     public string ProjectPath { get; set; } = string.Empty;
 
+    /// <summary>
+    /// Gets or sets the list of package analysis results for this project.
+    /// </summary>
     public List<PackageAnalysis> Packages { get; set; } = [];
 } 

src/NetContextClient/Models/RemoveIgnorePatternsResponse.cs

@@ -5,9 +5,18 @@ namespace NetContextClient.Models;
 /// </summary>
 public class RemoveIgnorePatternsResponse : IgnorePatternsResponse
 {
+    /// <summary>
+    /// Gets or sets the array of patterns that were successfully removed from the ignore list.
+    /// </summary>
     public string[] RemovedPatterns { get; set; } = [];
 
+    /// <summary>
+    /// Gets or sets the array of patterns that were not found in the ignore list.
+    /// </summary>
     public string[] NotFoundPatterns { get; set; } = [];
 
+    /// <summary>
+    /// Gets or sets the array of default patterns that could not be removed as they are system-defined.
+    /// </summary>
     public string[] DefaultPatternsSkipped { get; set; } = [];
 } 

src/NetContextClient/Models/SemanticSearchResponse.cs

@@ -5,5 +5,8 @@ namespace NetContextClient.Models;
 /// </summary>
 public class SemanticSearchResponse
 {
+    /// <summary>
+    /// Gets or sets the array of semantic search results ordered by relevance.
+    /// </summary>
     public SemanticSearchResult[] Results { get; set; } = [];
 }

src/NetContextClient/Models/SemanticSearchResult.cs

@@ -5,15 +5,33 @@ namespace NetContextClient.Models;
 /// </summary>
 public class SemanticSearchResult
 {
+    /// <summary>
+    /// Gets or sets the file path where the search result was found.
+    /// </summary>
     public string FilePath { get; set; } = string.Empty;
 
+    /// <summary>
+    /// Gets or sets the starting line number of the result in the file (1-based).
+    /// </summary>
     public int StartLine { get; set; }
 
+    /// <summary>
+    /// Gets or sets the ending line number of the result in the file (1-based).
+    /// </summary>
     public int EndLine { get; set; }
 
+    /// <summary>
+    /// Gets or sets the matched content from the file.
+    /// </summary>
     public string Content { get; set; } = string.Empty;
 
+    /// <summary>
+    /// Gets or sets the semantic similarity score of the result (higher is better).
+    /// </summary>
     public float Score { get; set; }
 
+    /// <summary>
+    /// Gets or sets the parent scope (e.g., namespace, class, or method) containing this result.
+    /// </summary>
     public string ParentScope { get; set; } = string.Empty;
 } 

src/NetContextClient/Models/StateFileLocationResponse.cs

@@ -5,5 +5,8 @@ namespace NetContextClient.Models;
 /// </summary>
 public class StateFileLocationResponse
 {
+    /// <summary>
+    /// Gets or sets the absolute path to the state file used for storing persistent configuration.
+    /// </summary>
     public string StateFilePath { get; set; } = string.Empty;
 }

src/NetContextServer/Extensions/StringExtensions.cs

@@ -1,7 +1,20 @@
 namespace NetContextServer.Extensions;
 
+/// <summary>
+/// Provides extension methods for string manipulation and code content formatting.
+/// </summary>
 internal static class StringExtensions
 {
+    /// <summary>
+    /// Extracts a name from a line of code following a specified keyword.
+    /// </summary>
+    /// <param name="line">The line of code to analyze.</param>
+    /// <param name="keyword">The keyword that precedes the name to extract.</param>
+    /// <returns>The extracted name, or an empty string if no name is found.</returns>
+    /// <remarks>
+    /// The method looks for the first occurrence of the keyword followed by a space,
+    /// then extracts the text until it encounters a space, opening brace, colon, or parenthesis.
+    /// </remarks>
     public static string ExtractName(string line, string keyword)
     {
         int keywordIndex = line.IndexOf(keyword + " ");
@@ -30,6 +43,15 @@ public static string ExtractName(string line, string keyword)
         return string.Empty;
     }
 
+    /// <summary>
+    /// Extracts a method name from a line of code.
+    /// </summary>
+    /// <param name="line">The line of code containing the method declaration.</param>
+    /// <returns>The extracted method name, or an empty string if no method name is found.</returns>
+    /// <remarks>
+    /// The method extracts the text between the last space and the opening parenthesis
+    /// in the line, which typically represents the method name in a method declaration.
+    /// </remarks>
     public static string ExtractMethodName(string line)
     {
         // Extract the method name from the line (text before the opening parenthesis)
@@ -50,6 +72,20 @@ public static string ExtractMethodName(string line)
         return string.Empty;
     }
 
+    /// <summary>
+    /// Formats code content by managing blank lines and structural elements for improved readability.
+    /// </summary>
+    /// <param name="content">The code content to format.</param>
+    /// <returns>The formatted code content with optimized blank line placement.</returns>
+    /// <remarks>
+    /// This method performs the following formatting operations:
+    /// <list type="bullet">
+    /// <item><description>Removes excessive blank lines</description></item>
+    /// <item><description>Ensures proper structure with opening/closing braces</description></item>
+    /// <item><description>Adds strategic blank lines before significant declarations</description></item>
+    /// <item><description>Maintains a maximum ratio of 25% blank lines</description></item>
+    /// </list>
+    /// </remarks>
     public static string FormatCodeContent(string content)
     {
         // First, remove all blank lines completely

src/NetContextServer/Models/CodeSnippet.cs

@@ -1,14 +1,32 @@
 namespace NetContextServer.Models;
 
+/// <summary>
+/// Represents a snippet of code from a source file with its associated metadata and embedding.
+/// </summary>
 public class CodeSnippet
 {
+    /// <summary>
+    /// Gets the full file path of the source code file.
+    /// </summary>
     public required string FilePath { get; init; }
 
+    /// <summary>
+    /// Gets the actual content/text of the code snippet.
+    /// </summary>
     public required string Content { get; init; }
 
+    /// <summary>
+    /// Gets the starting line number of the snippet in the source file (1-based).
+    /// </summary>
     public required int StartLine { get; init; }
 
+    /// <summary>
+    /// Gets the ending line number of the snippet in the source file (1-based).
+    /// </summary>
     public required int EndLine { get; init; }
 
+    /// <summary>
+    /// Gets the vector embedding representation of the code snippet used for semantic search.
+    /// </summary>
     public required ReadOnlyMemory<float> Embedding { get; init; }
 }