TfsChangeSetMappingToolOptions.ChangeSetMappingFile add missing comment

satano · satano · commit be0df4865db6 · 2025-10-31T13:43:53.000+01:00
diff --git a/docs/data/classes/reference.tools.tfschangesetmappingtool.yaml b/docs/data/classes/reference.tools.tfschangesetmappingtool.yaml
@@ -49,8 +49,8 @@ typeName: Tools
 options:
 - parameterName: ChangeSetMappingFile
   type: String
-  description: missing XML code comments
-  defaultValue: missing XML code comments
+  description: Path to changeset mapping file.
+  defaultValue: null
   isRequired: false
   dotNetType: System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e
 - parameterName: Enabled
diff --git a/docs/static/schema/configuration.schema.json b/docs/static/schema/configuration.schema.json
@@ -2251,8 +2251,9 @@
                   "default": "true"
                 },
                 "ChangeSetMappingFile": {
-                  "description": "missing XML code comments",
-                  "type": "string"
+                  "description": "Path to changeset mapping file.",
+                  "type": "string",
+                  "default": "null"
                 }
               }
             },
diff --git a/docs/static/schema/schema.tools.tfschangesetmappingtool.json b/docs/static/schema/schema.tools.tfschangesetmappingtool.json
@@ -6,8 +6,9 @@
   "type": "object",
   "properties": {
     "ChangeSetMappingFile": {
-      "description": "missing XML code comments",
-      "type": "string"
+      "description": "Path to changeset mapping file.",
+      "type": "string",
+      "default": "null"
     },
     "Enabled": {
       "description": "If set to `true` then the tool will run. Set to `false` and the processor will not run.",
diff --git a/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsChangeSetMappingToolOptions.cs b/src/MigrationTools.Clients.TfsObjectModel/Tools/TfsChangeSetMappingToolOptions.cs
@@ -1,13 +1,13 @@
-﻿using System;
-using MigrationTools.Enrichers;
-using MigrationTools.Tools.Infrastructure;
+﻿using MigrationTools.Tools.Infrastructure;
 
 namespace MigrationTools.Tools
 {
     public class TfsChangeSetMappingToolOptions : ToolOptions
     {
-
+        /// <summary>
+        /// Path to changeset mapping file.
+        /// </summary>
+        /// <default>null</default>
         public string ChangeSetMappingFile { get; set; }
-
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -2251,8 +2251,9 @@`
`2251`	`2251`	`"default": "true"`
`2252`	`2252`	`},`
`2253`	`2253`	`"ChangeSetMappingFile": {`
`2254`		`- "description": "missing XML code comments",`
`2255`		`- "type": "string"`
	`2254`	`+ "description": "Path to changeset mapping file.",`
	`2255`	`+ "type": "string",`
	`2256`	`+ "default": "null"`
`2256`	`2257`	`}`
`2257`	`2258`	`}`
`2258`	`2259`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,13 @@`
`1`		`-using System;`
`2`		`-using MigrationTools.Enrichers;`
`3`		`-using MigrationTools.Tools.Infrastructure;`
	`1`	`+using MigrationTools.Tools.Infrastructure;`
`4`	`2`
`5`	`3`	`namespace MigrationTools.Tools`
`6`	`4`	`{`
`7`	`5`	`public class TfsChangeSetMappingToolOptions : ToolOptions`
`8`	`6`	`{`
`9`		`-`
	`7`	`+ /// <summary>`
	`8`	`+ /// Path to changeset mapping file.`
	`9`	`+ /// </summary>`
	`10`	`+ /// <default>null</default>`
`10`	`11`	`public string ChangeSetMappingFile { get; set; }`
`11`		`-`
`12`	`12`	`}`
`13`		`-}`
	`13`	`+}`