📝 Add comprehensive XML documentation comments to Processors, Tools, and FieldMaps

docs/_data/reference.endpoints.azuredevopsendpoint.yaml

@@ -39,32 +39,32 @@ configurationSamples:
       "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId"
     }
   sampleFor: MigrationTools.Endpoints.AzureDevOpsEndpointOptions
-description: missing XML code comments
+description: Azure DevOps REST API endpoint implementation for connecting to Azure DevOps organizations. Provides HTTP client access and pipeline-related API operations for migration scenarios.
 className: AzureDevOpsEndpoint
 typeName: Endpoints
 architecture: 
 options:
 - parameterName: AccessToken
   type: String
-  description: missing XML code comments
+  description: Personal Access Token (PAT) or other authentication token for accessing the Azure DevOps organization. Required for API authentication.
   defaultValue: missing XML code comments
 - parameterName: AuthenticationMode
   type: AuthenticationMode
-  description: missing XML code comments
+  description: Authentication mode to use when connecting to Azure DevOps. Typically uses AccessToken for modern Azure DevOps organizations.
   defaultValue: missing XML code comments
 - parameterName: Organisation
   type: String
-  description: missing XML code comments
+  description: URL of the Azure DevOps organization (e.g., "https://dev.azure.com/myorganization/"). Must include the full organization URL.
   defaultValue: missing XML code comments
 - parameterName: Project
   type: String
-  description: missing XML code comments
+  description: Name of the Azure DevOps project within the organization to connect to. This is the project that will be used for migration operations.
   defaultValue: missing XML code comments
 - parameterName: ReflectedWorkItemIdField
   type: String
-  description: missing XML code comments
+  description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: /src/MigrationTools.Clients.AzureDevops.Rest/Endpoints/AzureDevOpsEndpoint.cs
-optionsClassFile: /src/MigrationTools.Clients.AzureDevops.Rest/Endpoints/AzureDevOpsEndpointOptions.cs
+classFile: src/MigrationTools.Clients.AzureDevops.Rest/Endpoints/AzureDevOpsEndpoint.cs
+optionsClassFile: src/MigrationTools.Clients.AzureDevops.Rest/Endpoints/AzureDevOpsEndpointOptions.cs

docs/_data/reference.endpoints.filesystemworkitemendpoint.yaml

@@ -27,9 +27,9 @@ architecture:
 options:
 - parameterName: FileStore
   type: String
-  description: missing XML code comments
+  description: Path to the directory where work item data will be stored or read from. This should be a valid local file system path with appropriate read/write permissions.
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: /src/MigrationTools.Clients.FileSystem/Endpoints/FileSystemWorkItemEndpoint.cs
-optionsClassFile: /src/MigrationTools.Clients.FileSystem/Endpoints/FileSystemWorkItemEndpointOptions.cs
+classFile: src/MigrationTools.Clients.FileSystem/Endpoints/FileSystemWorkItemEndpoint.cs
+optionsClassFile: src/MigrationTools.Clients.FileSystem/Endpoints/FileSystemWorkItemEndpointOptions.cs

docs/_data/reference.endpoints.tfsendpoint.yaml

@@ -97,25 +97,25 @@ architecture:
 options:
 - parameterName: Authentication
   type: TfsAuthenticationOptions
-  description: missing XML code comments
+  description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
   defaultValue: missing XML code comments
 - parameterName: Collection
   type: Uri
-  description: missing XML code comments
+  description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
   defaultValue: missing XML code comments
 - parameterName: LanguageMaps
   type: TfsLanguageMapOptions
-  description: missing XML code comments
+  description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
   defaultValue: missing XML code comments
 - parameterName: Project
   type: String
-  description: missing XML code comments
+  description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
   defaultValue: missing XML code comments
 - parameterName: ReflectedWorkItemIdField
   type: String
-  description: missing XML code comments
+  description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsEndpoint.cs
-optionsClassFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsEndpointOptions.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsEndpoint.cs
+optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsEndpointOptions.cs

docs/_data/reference.endpoints.tfsteamprojectendpoint.yaml

@@ -93,25 +93,25 @@ architecture:
 options:
 - parameterName: Authentication
   type: TfsAuthenticationOptions
-  description: missing XML code comments
+  description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
   defaultValue: missing XML code comments
 - parameterName: Collection
   type: Uri
-  description: missing XML code comments
+  description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
   defaultValue: missing XML code comments
 - parameterName: LanguageMaps
   type: TfsLanguageMapOptions
-  description: missing XML code comments
+  description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
   defaultValue: missing XML code comments
 - parameterName: Project
   type: String
-  description: missing XML code comments
+  description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
   defaultValue: missing XML code comments
 - parameterName: ReflectedWorkItemIdField
   type: String
-  description: missing XML code comments
+  description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamProjectEndpoint.cs
-optionsClassFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamProjectEndPointOptions.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamProjectEndpoint.cs
+optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamProjectEndPointOptions.cs

docs/_data/reference.endpoints.tfsteamsettingsendpoint.yaml

@@ -34,25 +34,25 @@ architecture:
 options:
 - parameterName: Authentication
   type: TfsAuthenticationOptions
-  description: missing XML code comments
+  description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
   defaultValue: missing XML code comments
 - parameterName: Collection
   type: Uri
-  description: missing XML code comments
+  description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
   defaultValue: missing XML code comments
 - parameterName: LanguageMaps
   type: TfsLanguageMapOptions
-  description: missing XML code comments
+  description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
   defaultValue: missing XML code comments
 - parameterName: Project
   type: String
-  description: missing XML code comments
+  description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
   defaultValue: missing XML code comments
 - parameterName: ReflectedWorkItemIdField
   type: String
-  description: missing XML code comments
+  description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamSettingsEndpoint.cs
-optionsClassFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamSettingsEndpointOptions.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamSettingsEndpoint.cs
+optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsTeamSettingsEndpointOptions.cs

docs/_data/reference.endpoints.tfsworkitemendpoint.yaml

@@ -35,29 +35,29 @@ architecture:
 options:
 - parameterName: Authentication
   type: TfsAuthenticationOptions
-  description: missing XML code comments
+  description: Authentication configuration for connecting to the TFS server. Supports various authentication modes including Windows authentication and access tokens.
   defaultValue: missing XML code comments
 - parameterName: Collection
   type: Uri
-  description: missing XML code comments
+  description: URI of the TFS collection (e.g., "http://tfsserver:8080/tfs/DefaultCollection"). Must be a valid absolute URL pointing to the TFS collection.
   defaultValue: missing XML code comments
 - parameterName: LanguageMaps
   type: TfsLanguageMapOptions
-  description: missing XML code comments
+  description: Language mapping configuration for translating area and iteration path names between different language versions of TFS.
   defaultValue: missing XML code comments
 - parameterName: Project
   type: String
-  description: missing XML code comments
+  description: Name of the TFS project within the collection to connect to. This is the project that will be used for migration operations.
   defaultValue: missing XML code comments
 - parameterName: Query
   type: QueryOptions
-  description: missing XML code comments
+  description: Gets or sets the query options that define which work items to retrieve from the source endpoint, including WIQL queries and parameters.
   defaultValue: missing XML code comments
 - parameterName: ReflectedWorkItemIdField
   type: String
-  description: missing XML code comments
+  description: Name of the custom field used to store the reflected work item ID for tracking migrated items. Typically "Custom.ReflectedWorkItemId".
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsWorkItemEndpoint.cs
-optionsClassFile: /src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsWorkItemEndpointOptions.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsWorkItemEndpoint.cs
+optionsClassFile: src/MigrationTools.Clients.TfsObjectModel/EndPoints/TfsWorkItemEndpointOptions.cs

docs/_data/reference.fieldmaps.fieldclearmap.yaml

@@ -59,7 +59,7 @@ configurationSamples:
       ]
     }
   sampleFor: MigrationTools.Tools.FieldClearMapOptions
-description: missing XML code comments
+description: Clears a target field by setting its value to null, useful for removing data from specific fields during migration.
 className: FieldClearMap
 typeName: FieldMaps
 architecture: 
@@ -70,9 +70,9 @@ options:
   defaultValue: missing XML code comments
 - parameterName: targetField
   type: String
-  description: missing XML code comments
+  description: Gets or sets the name of the target field to be cleared/set to null during work item migration.
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: /src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldClearMap.cs
-optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldClearMapOptions.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldClearMap.cs
+optionsClassFile: src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldClearMapOptions.cs

docs/_data/reference.fieldmaps.fieldliteralmap.yaml

@@ -61,7 +61,7 @@ configurationSamples:
       ]
     }
   sampleFor: MigrationTools.Tools.FieldLiteralMapOptions
-description: missing XML code comments
+description: Maps a literal (static) value to a target field, useful for setting constant values across all migrated work items.
 className: FieldLiteralMap
 typeName: FieldMaps
 architecture: 
@@ -72,13 +72,13 @@ options:
   defaultValue: missing XML code comments
 - parameterName: targetField
   type: String
-  description: missing XML code comments
+  description: Gets or sets the name of the target field that will be set to the specified literal value.
   defaultValue: missing XML code comments
 - parameterName: value
   type: String
-  description: missing XML code comments
+  description: Gets or sets the literal value that will be assigned to the target field during migration.
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: /src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldLiteralMap.cs
-optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldLiteralMapOptions.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldLiteralMap.cs
+optionsClassFile: src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldLiteralMapOptions.cs

docs/_data/reference.fieldmaps.fieldmergemap.yaml

@@ -69,7 +69,7 @@ configurationSamples:
       ]
     }
   sampleFor: MigrationTools.Tools.FieldMergeMapOptions
-description: missing XML code comments
+description: Merges values from multiple source fields into a single target field using a specified format template.
 className: FieldMergeMap
 typeName: FieldMaps
 architecture: 
@@ -92,5 +92,5 @@ options:
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: /src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldMergeMap.cs
-optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldMergeMapOptions.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldMergeMap.cs
+optionsClassFile: src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldMergeMapOptions.cs

docs/_data/reference.fieldmaps.fieldskipmap.yaml

@@ -40,7 +40,7 @@ configurationSamples:
       ]
     }
   sampleFor: MigrationTools.Tools.FieldSkipMapOptions
-description: missing XML code comments
+description: Skips field mapping for a specific target field, effectively leaving the field unchanged during migration.
 className: FieldSkipMap
 typeName: FieldMaps
 architecture: 
@@ -51,9 +51,9 @@ options:
   defaultValue: missing XML code comments
 - parameterName: targetField
   type: String
-  description: missing XML code comments
+  description: Gets or sets the name of the target field that should be skipped during migration, resetting it to its original value.
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: /src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldSkipMap.cs
-optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldSkipMapOptions.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldSkipMap.cs
+optionsClassFile: src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldSkipMapOptions.cs

docs/_data/reference.fieldmaps.fieldtofieldmap.yaml

@@ -63,7 +63,7 @@ configurationSamples:
       ]
     }
   sampleFor: MigrationTools.Tools.FieldToFieldMapOptions
-description: missing XML code comments
+description: Maps the value from a source field to a target field directly, with optional default value substitution for empty or null values.
 className: FieldToFieldMap
 typeName: FieldMaps
 architecture: 
@@ -74,17 +74,17 @@ options:
   defaultValue: missing XML code comments
 - parameterName: defaultValue
   type: String
-  description: missing XML code comments
+  description: Gets or sets the default value to use when the source field is empty or null.
   defaultValue: missing XML code comments
 - parameterName: sourceField
   type: String
-  description: missing XML code comments
+  description: Gets or sets the name of the source field to copy data from during migration.
   defaultValue: missing XML code comments
 - parameterName: targetField
   type: String
-  description: missing XML code comments
+  description: Gets or sets the name of the target field to copy data to during migration.
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: /src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldToFieldMap.cs
-optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldtoFieldMapOptions.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldToFieldMap.cs
+optionsClassFile: src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldtoFieldMapOptions.cs

docs/_data/reference.fieldmaps.fieldtofieldmultimap.yaml

@@ -82,5 +82,5 @@ options:
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: /src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldtoFieldMultiMap.cs
-optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldtoFieldMultiMapOptions.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldtoFieldMultiMap.cs
+optionsClassFile: src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldtoFieldMultiMapOptions.cs

docs/_data/reference.fieldmaps.fieldtotagfieldmap.yaml

@@ -84,5 +84,5 @@ options:
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: /src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldToTagFieldMap.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldToTagFieldMap.cs
 optionsClassFile: ''

docs/_data/reference.fieldmaps.fieldvaluemap.yaml

@@ -69,7 +69,7 @@ configurationSamples:
       ]
     }
   sampleFor: MigrationTools.Tools.FieldValueMapOptions
-description: missing XML code comments
+description: Maps field values based on a lookup table, allowing specific source values to be translated to different target values.
 className: FieldValueMap
 typeName: FieldMaps
 architecture: 
@@ -80,21 +80,21 @@ options:
   defaultValue: missing XML code comments
 - parameterName: defaultValue
   type: String
-  description: missing XML code comments
+  description: Gets or sets the default value to use when no mapping is found for the source field value.
   defaultValue: missing XML code comments
 - parameterName: sourceField
   type: String
-  description: missing XML code comments
+  description: Gets or sets the name of the source field to read values from during migration.
   defaultValue: missing XML code comments
 - parameterName: targetField
   type: String
-  description: missing XML code comments
+  description: Gets or sets the name of the target field to write mapped values to during migration.
   defaultValue: missing XML code comments
 - parameterName: valueMapping
   type: Dictionary
-  description: missing XML code comments
+  description: Gets or sets the dictionary that maps source field values to target field values. Key is the source value, value is the target value.
   defaultValue: missing XML code comments
 status: missing XML code comments
 processingTarget: missing XML code comments
-classFile: /src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldValueMap.cs
-optionsClassFile: /src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldValueMapOptions.cs
+classFile: src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMaps/FieldValueMap.cs
+optionsClassFile: src/MigrationTools/Tools/FieldMappingTool/FieldMaps/FieldValueMapOptions.cs