📝 Add comprehensive property documentation to Options classes

Copilot · MrHinsh · Copilot · commit 55bd081e77d0 · 2025-06-16T08:35:29.000Z
Co-authored-by: MrHinsh &lt;5205575+MrHinsh@users.noreply.github.com&gt;
diff --git a/src/MigrationTools.Clients.AzureDevops.Rest/Processors/AzureDevOpsPipelineProcessorOptions.cs b/src/MigrationTools.Clients.AzureDevops.Rest/Processors/AzureDevOpsPipelineProcessorOptions.cs
@@ -46,7 +46,7 @@ public AzureDevOpsPipelineProcessorOptions()
         public bool MigrateTaskGroups { get; set; }
 
         /// <summary>
-        /// Migrate Valiable Groups
+        /// Migrate Variable Groups
         /// </summary>
         /// <default>true</default>
         public bool MigrateVariableGroups { get; set; }
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsLanguageMapOptions.cs b/src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsLanguageMapOptions.cs
@@ -5,9 +5,21 @@
 
 namespace MigrationTools.Endpoints
 {
+    /// <summary>
+    /// Configuration options for mapping language-specific field names between source and target TFS systems. Used to translate area path and iteration path field names when migrating between TFS instances with different language configurations.
+    /// </summary>
     public class TfsLanguageMapOptions : IValidateOptions<TfsLanguageMapOptions>
     {
+        /// <summary>
+        /// Gets or sets the field name for the area path in the TFS system language (e.g., "Area" for English, "Zone" for French).
+        /// </summary>
+        /// <default>Area</default>
         public string AreaPath { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the field name for the iteration path in the TFS system language (e.g., "Iteration" for English, "Itération" for French).
+        /// </summary>
+        /// <default>Iteration</default>
         public string IterationPath { get; set; }
 
         public ValidateOptionsResult Validate(string name, TfsLanguageMapOptions options)
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsWorkItemEndpointOptions.cs b/src/MigrationTools.Clients.TfsObjectModel/Endpoints/TfsWorkItemEndpointOptions.cs
@@ -2,8 +2,14 @@
 
 namespace MigrationTools.Endpoints
 {
+    /// <summary>
+    /// Configuration options for the TFS/Azure DevOps Work Item Endpoint that defines connection settings and query options for accessing work items in Team Foundation Server or Azure DevOps Server.
+    /// </summary>
     public class TfsWorkItemEndpointOptions : TfsEndpointOptions
     {
+        /// <summary>
+        /// Gets or sets the query options that define which work items to retrieve from the source endpoint, including WIQL queries and parameters.
+        /// </summary>
         public QueryOptions Query { get; set; }
 
         //public override void SetDefaults()
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Processors/TfsWorkItemBulkEditProcessorOptions.cs b/src/MigrationTools.Clients.TfsObjectModel/Processors/TfsWorkItemBulkEditProcessorOptions.cs
@@ -11,6 +11,10 @@ namespace MigrationTools._EngineV1.Configuration.Processing
     /// </summary>
     public class TfsWorkItemBulkEditProcessorOptions : ProcessorOptions, IWorkItemProcessorConfig
     {
+        /// <summary>
+        /// Gets or sets a value indicating whether to run in "what if" mode without making actual changes to work items.
+        /// </summary>
+        /// <default>false</default>
         public bool WhatIf { get; set; }
 
 
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Processors/TfsWorkItemDeleteProcessorOptions.cs b/src/MigrationTools.Clients.TfsObjectModel/Processors/TfsWorkItemDeleteProcessorOptions.cs
@@ -6,20 +6,45 @@
 
 namespace MigrationTools.Processors
 {
+    /// <summary>
+    /// Configuration options for the TFS Work Item Delete Processor that removes work items from the target system based on specified criteria.
+    /// </summary>
     public class TfsWorkItemDeleteProcessorOptions : ProcessorOptions, IWorkItemProcessorConfig
     {
 
-
+        /// <summary>
+        /// Initializes a new instance of the TfsWorkItemDeleteProcessorOptions class with default settings.
+        /// </summary>
         public TfsWorkItemDeleteProcessorOptions()
         {
             Enabled = false;
             WIQLQuery = @"SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc";
         }
 
+        /// <summary>
+        /// Gets or sets the WIQL query used to select work items for deletion. Should return a list of work item IDs.
+        /// </summary>
+        /// <default>SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc</default>
         public string WIQLQuery { get; set; }
+        
+        /// <summary>
+        /// Gets or sets a specific list of work item IDs to delete. When specified, takes precedence over the WIQL query.
+        /// </summary>
         public IList<int> WorkItemIDs { get; set; }
+        
+        /// <summary>
+        /// Gets or sets a value indicating whether to filter out work items that already exist in the target before deletion. Typically used to avoid deleting items that shouldn't be removed.
+        /// </summary>
         public bool FilterWorkItemsThatAlreadyExistInTarget { get; set; }
+        
+        /// <summary>
+        /// Gets or sets a value indicating whether to pause after each work item is deleted for review or debugging purposes.
+        /// </summary>
         public bool PauseAfterEachWorkItem { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the number of retry attempts for work item deletion operations when they fail due to transient errors.
+        /// </summary>
         public int WorkItemCreateRetryLimit { get; set; }
 
     }
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsAttachmentToolOptions.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsAttachmentToolOptions.cs
@@ -2,6 +2,9 @@
 
 namespace MigrationTools.Tools
 {
+    /// <summary>
+    /// Configuration options for the TFS Attachment Tool that handles the migration of work item attachments between TFS/Azure DevOps systems.
+    /// </summary>
     public class TfsAttachmentToolOptions : ToolOptions, ITfsAttachmentToolOptions
     {
         /// <summary>
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsUserMappingToolOptions.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsUserMappingToolOptions.cs
@@ -4,6 +4,9 @@
 
 namespace MigrationTools.Tools
 {
+    /// <summary>
+    /// Configuration options for the TFS User Mapping Tool that handles the mapping of user identities between source and target systems during work item migration.
+    /// </summary>
     public class TfsUserMappingToolOptions : ToolOptions, ITfsUserMappingToolOptions
     {
 
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsValidateRequiredFieldToolOptions.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsValidateRequiredFieldToolOptions.cs
@@ -4,6 +4,9 @@
 
 namespace MigrationTools.Tools
 {
+    /// <summary>
+    /// Configuration options for the TFS Validate Required Field Tool that ensures all required fields are properly populated during work item migration.
+    /// </summary>
     public class TfsValidateRequiredFieldToolOptions : ToolOptions
     {
 
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsWorkItemLinkToolOptions.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsWorkItemLinkToolOptions.cs
@@ -6,6 +6,9 @@
 
 namespace MigrationTools.Tools
 {
+    /// <summary>
+    /// Configuration options for the TFS Work Item Link Tool that manages the migration and processing of work item links between items.
+    /// </summary>
     public class TfsWorkItemLinkToolOptions : ToolOptions, ITfsWorkItemLinkToolOptions
     {
 
diff --git a/src/MigrationTools.ConsoleDataGenerator/ClassDataLoader.cs b/src/MigrationTools.ConsoleDataGenerator/ClassDataLoader.cs
@@ -21,8 +21,8 @@ namespace MigrationTools.ConsoleDataGenerator
     public class ClassDataLoader
     {
         private DataSerialization saveData;
-        private static CodeDocumentation codeDocs = new CodeDocumentation("../../../../../docs/Reference/Generated/");
-        private static CodeFileFinder codeFinder = new CodeFileFinder("../../../../../src/");
+        private static CodeDocumentation codeDocs = new CodeDocumentation("../../docs/Reference/Generated/");
+        private static CodeFileFinder codeFinder = new CodeFileFinder("../");
         private IConfiguration configuration;
         public ClassDataLoader(DataSerialization saveData, Microsoft.Extensions.Configuration.IConfiguration configuration)
         {
diff --git a/src/MigrationTools.ConsoleDataGenerator/CodeFileFinder.cs b/src/MigrationTools.ConsoleDataGenerator/CodeFileFinder.cs
@@ -26,7 +26,7 @@ public string FindCodeFile(Type typeToFind)
             {
                var fileInfo = new FileInfo(files[0]);
 
-                return files[0].Replace("../../../../..", "").Replace("\\", "/");
+                return files[0].Replace("../../", "").Replace("\\", "/");
             }
             return "";
         }
diff --git a/src/MigrationTools.ConsoleDataGenerator/Program.cs b/src/MigrationTools.ConsoleDataGenerator/Program.cs
@@ -26,8 +26,8 @@ namespace MigrationTools.ConsoleDataGenerator;
 class Program
 {
     private static IConfiguration configuration = GetConfiguration();
-    private static DataSerialization saveData = new DataSerialization("../../../../../docs/_data/");
-    private static CodeDocumentation codeDocs = new CodeDocumentation("../../../../../docs/Reference/Generated/");
+    private static DataSerialization saveData = new DataSerialization("../../docs/_data/");
+    private static CodeDocumentation codeDocs = new CodeDocumentation("../../docs/Reference/Generated/");
     private static ClassDataLoader cdLoader = new ClassDataLoader(saveData, configuration);
     private static MarkdownLoader mdLoader = new MarkdownLoader();
     
diff --git a/src/MigrationTools/Options/NetworkCredentialsOptions.cs b/src/MigrationTools/Options/NetworkCredentialsOptions.cs
@@ -8,18 +8,41 @@
 
 namespace MigrationTools.Options
 {
+    /// <summary>
+    /// Configuration options for network credentials used when connecting to source and target systems. This class is marked as obsolete and should not be used in new implementations.
+    /// </summary>
     [Obsolete]
     public class NetworkCredentialsOptions
     {
+        /// <summary>
+        /// Gets or sets the network credentials for connecting to the source system.
+        /// </summary>
         public NetworkCredentials Source { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the network credentials for connecting to the target system.
+        /// </summary>
         public NetworkCredentials Target { get; set; }
     }
 
+    /// <summary>
+    /// Represents network authentication credentials including domain, username, and password for connecting to TFS or other network-based systems.
+    /// </summary>
     public class NetworkCredentials : IValidateOptions<NetworkCredentials>
     {
+        /// <summary>
+        /// Gets or sets the domain name for Windows authentication (e.g., "CONTOSO" or "contoso.com").
+        /// </summary>
         public string Domain { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the username for authentication. Should not include the domain prefix.
+        /// </summary>
         public string UserName { get; set; }
 
+        /// <summary>
+        /// Gets or sets the password for authentication. This value is masked in JSON serialization for security.
+        /// </summary>
         [JsonConverter(typeof(DefaultOnlyConverter<string>), "** removed as a secret ***")]
         public string Password { get; set; }
 
diff --git a/src/MigrationTools/Options/QueryOptions.cs b/src/MigrationTools/Options/QueryOptions.cs
@@ -3,11 +3,20 @@
 
 namespace MigrationTools.Options
 {
+    /// <summary>
+    /// Configuration options for defining work item queries used in migration processes. Supports WIQL (Work Item Query Language) queries with parameterization.
+    /// </summary>
     public class QueryOptions
     {
+        /// <summary>
+        /// Gets or sets the WIQL (Work Item Query Language) query string used to select work items for processing. Must be a valid WIQL query.
+        /// </summary>
         [Required]
         public string Query { get; set; }
 
+        /// <summary>
+        /// Gets or sets a dictionary of query parameters that can be substituted into the WIQL query. Key represents the parameter name, value represents the parameter value.
+        /// </summary>
         public Dictionary<string, string> Parameters { get; set; }
     }
 }
diff --git a/src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldClearMapOptions.cs b/src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldClearMapOptions.cs
@@ -10,6 +10,9 @@ namespace MigrationTools.Tools
     /// <processingtarget>Work Item</processingtarget>
     public class FieldClearMapOptions : FieldMapOptions
     {
+        /// <summary>
+        /// Gets or sets the name of the target field to be cleared/set to null during work item migration.
+        /// </summary>
         public string targetField { get; set; }
 
         public void SetExampleConfigDefaults()
diff --git a/src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldLiteralMapOptions.cs b/src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldLiteralMapOptions.cs
@@ -10,9 +10,14 @@ namespace MigrationTools.Tools
     /// <processingtarget>Work Item Field</processingtarget>
     public class FieldLiteralMapOptions : FieldMapOptions
     {
-
+        /// <summary>
+        /// Gets or sets the name of the target field that will be set to the specified literal value.
+        /// </summary>
         public string targetField { get; set; }
 
+        /// <summary>
+        /// Gets or sets the literal value that will be assigned to the target field during migration.
+        /// </summary>
         public string value { get; set; }
 
         public void SetExampleConfigDefaults()
diff --git a/src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldSkipMapOptions.cs b/src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldSkipMapOptions.cs
@@ -10,6 +10,9 @@ namespace MigrationTools.Tools
     /// <processingtarget>Work Item</processingtarget>
     public class FieldSkipMapOptions : FieldMapOptions
     {
+        /// <summary>
+        /// Gets or sets the name of the target field that should be skipped during migration, resetting it to its original value.
+        /// </summary>
         public string targetField { get; set; }
 
 
diff --git a/src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldValueMapOptions.cs b/src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldValueMapOptions.cs
@@ -10,9 +10,24 @@ namespace MigrationTools.Tools
     /// <processingtarget>Work Item Field</processingtarget>
     public class FieldValueMapOptions : FieldMapOptions
     {
+        /// <summary>
+        /// Gets or sets the name of the source field to read values from during migration.
+        /// </summary>
         public string sourceField { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the name of the target field to write mapped values to during migration.
+        /// </summary>
         public string targetField { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the default value to use when no mapping is found for the source field value.
+        /// </summary>
         public string defaultValue { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the dictionary that maps source field values to target field values. Key is the source value, value is the target value.
+        /// </summary>
         public Dictionary<string, string> valueMapping { get; set; }
 
         public void SetExampleConfigDefaults()
diff --git a/src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldtoFieldMapOptions.cs b/src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldtoFieldMapOptions.cs
@@ -11,8 +11,19 @@ namespace MigrationTools.Tools
     /// <processingtarget>Work Item Field</processingtarget>
     public class FieldToFieldMapOptions : FieldMapOptions
     {
+        /// <summary>
+        /// Gets or sets the name of the source field to copy data from during migration.
+        /// </summary>
         public string sourceField { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the name of the target field to copy data to during migration.
+        /// </summary>
         public string targetField { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the default value to use when the source field is empty or null.
+        /// </summary>
         public string defaultValue { get; set; }
 
         public void SetExampleConfigDefaults()
diff --git a/src/MigrationTools/Tools/FieldMappingTool/FieldMaps/RegexFieldMapOptions.cs b/src/MigrationTools/Tools/FieldMappingTool/FieldMaps/RegexFieldMapOptions.cs
@@ -9,9 +9,24 @@ namespace MigrationTools.Tools
     /// <processingtarget>Work Item Field</processingtarget>
     public class RegexFieldMapOptions : FieldMapOptions
     {
+        /// <summary>
+        /// Gets or sets the name of the source field to read data from and apply regex pattern matching.
+        /// </summary>
         public string sourceField { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the name of the target field to write the regex-transformed data to.
+        /// </summary>
         public string targetField { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the regular expression pattern to match against the source field value.
+        /// </summary>
         public string pattern { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the replacement pattern that defines how matched groups should be used to construct the target value.
+        /// </summary>
         public string replacement { get; set; }
 
         public void SetExampleConfigDefaults()
diff --git a/src/MigrationTools/Tools/FieldMappingTool/FieldMaps/TreeToTagFieldMapOptions.cs b/src/MigrationTools/Tools/FieldMappingTool/FieldMaps/TreeToTagFieldMapOptions.cs
@@ -10,7 +10,14 @@ namespace MigrationTools.Tools
     /// <processingtarget>Work Item Field</processingtarget>
     public class TreeToTagFieldMapOptions : FieldMapOptions
     {
+        /// <summary>
+        /// Gets or sets the number of levels to skip from the root when converting area path hierarchy to tags. For example, if set to 2, "ProjectName\Level1\Level2\Level3" would skip "ProjectName\Level1" and start from "Level2".
+        /// </summary>
         public int toSkip { get; set; }
+        
+        /// <summary>
+        /// Gets or sets the number of months to travel back in time when looking up historical area path values. Use 0 for current values.
+        /// </summary>
         public int timeTravel { get; set; }
 
         public void SetExampleConfigDefaults()

Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,14 @@`
`2`	`2`
`3`	`3`	`namespace MigrationTools.Endpoints`
`4`	`4`	`{`
	`5`	`+ /// <summary>`
	`6`	`+ /// Configuration options for the TFS/Azure DevOps Work Item Endpoint that defines connection settings and query options for accessing work items in Team Foundation Server or Azure DevOps Server.`
	`7`	`+ /// </summary>`
`5`	`8`	`public class TfsWorkItemEndpointOptions : TfsEndpointOptions`
`6`	`9`	`{`
	`10`	`+ /// <summary>`
	`11`	`+ /// Gets or sets the query options that define which work items to retrieve from the source endpoint, including WIQL queries and parameters.`
	`12`	`+ /// </summary>`
`7`	`13`	`public QueryOptions Query { get; set; }`
`8`	`14`
`9`	`15`	`//public override void SetDefaults()`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,10 @@ namespace MigrationTools._EngineV1.Configuration.Processing`
`11`	`11`	`/// </summary>`
`12`	`12`	`public class TfsWorkItemBulkEditProcessorOptions : ProcessorOptions, IWorkItemProcessorConfig`
`13`	`13`	`{`
	`14`	`+ /// <summary>`
	`15`	`+ /// Gets or sets a value indicating whether to run in "what if" mode without making actual changes to work items.`
	`16`	`+ /// </summary>`
	`17`	`+ /// <default>false</default>`
`14`	`18`	`public bool WhatIf { get; set; }`
`15`	`19`
`16`	`20`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace MigrationTools.Tools`
`4`	`4`	`{`
	`5`	`+ /// <summary>`
	`6`	`+ /// Configuration options for the TFS Attachment Tool that handles the migration of work item attachments between TFS/Azure DevOps systems.`
	`7`	`+ /// </summary>`
`5`	`8`	`public class TfsAttachmentToolOptions : ToolOptions, ITfsAttachmentToolOptions`
`6`	`9`	`{`
`7`	`10`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,9 @@`
`4`	`4`
`5`	`5`	`namespace MigrationTools.Tools`
`6`	`6`	`{`
	`7`	`+ /// <summary>`
	`8`	`+ /// Configuration options for the TFS User Mapping Tool that handles the mapping of user identities between source and target systems during work item migration.`
	`9`	`+ /// </summary>`
`7`	`10`	`public class TfsUserMappingToolOptions : ToolOptions, ITfsUserMappingToolOptions`
`8`	`11`	`{`
`9`	`12`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,9 @@`
`6`	`6`
`7`	`7`	`namespace MigrationTools.Tools`
`8`	`8`	`{`
	`9`	`+ /// <summary>`
	`10`	`+ /// Configuration options for the TFS Work Item Link Tool that manages the migration and processing of work item links between items.`
	`11`	`+ /// </summary>`
`9`	`12`	`public class TfsWorkItemLinkToolOptions : ToolOptions, ITfsWorkItemLinkToolOptions`
`10`	`13`	`{`
`11`	`14`
Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,8 @@ namespace MigrationTools.ConsoleDataGenerator`
`21`	`21`	`public class ClassDataLoader`
`22`	`22`	`{`
`23`	`23`	`private DataSerialization saveData;`
`24`		`- private static CodeDocumentation codeDocs = new CodeDocumentation("../../../../../docs/Reference/Generated/");`
`25`		`- private static CodeFileFinder codeFinder = new CodeFileFinder("../../../../../src/");`
	`24`	`+ private static CodeDocumentation codeDocs = new CodeDocumentation("../../docs/Reference/Generated/");`
	`25`	`+ private static CodeFileFinder codeFinder = new CodeFileFinder("../");`
`26`	`26`	`private IConfiguration configuration;`
`27`	`27`	`public ClassDataLoader(DataSerialization saveData, Microsoft.Extensions.Configuration.IConfiguration configuration)`
`28`	`28`	`{`