Updated docs

nkdAgility · Jan 25, 2024 · 35f1be6 · 35f1be6
1 parent 14dd7a0
commit 35f1be6
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 12 deletions.
diff --git a/docs/_data/reference.v2.processorenrichers.tfsworkitemlinkenricher.yaml b/docs/_data/reference.v2.processorenrichers.tfsworkitemlinkenricher.yaml
@@ -1,12 +1,38 @@
-optionsClassName: 
-optionsClassFullName: 
-configurationSamples: []
+optionsClassName: TfsWorkItemLinkEnricherOptions
+optionsClassFullName: MigrationTools.Enrichers.TfsWorkItemLinkEnricherOptions
+configurationSamples:
+- name: default
+ description: 
+ code: >-
+ {
+ "$type": "TfsWorkItemLinkEnricherOptions",
+ "Enabled": true,
+ "FilterIfLinkCountMatches": true,
+ "SaveAfterEachLinkIsAdded": false
+ }
+ sampleFor: MigrationTools.Enrichers.TfsWorkItemLinkEnricherOptions
 description: missng XML code comments
 className: TfsWorkItemLinkEnricher
 typeName: ProcessorEnrichers
 architecture: v2
-options: []
+options:
+- parameterName: Enabled
+ type: Boolean
+ description: For internal use
+ defaultValue: missng XML code comments
+- parameterName: FilterIfLinkCountMatches
+ type: Boolean
+ description: Skip validating links if the number of links in the source and the target matches!
+ defaultValue: missng XML code comments
+- parameterName: RefName
+ type: String
+ description: For internal use
+ defaultValue: missng XML code comments
+- parameterName: SaveAfterEachLinkIsAdded
+ type: Boolean
+ description: Save the work item after each link is added. This will slow the migration as it will cause many saves to the TFS database.
+ defaultValue: missng XML code comments
 status: missng XML code comments
 processingTarget: missng XML code comments
-classFile: /src/MigrationTools.Clients.AzureDevops.ObjectModel/Enrichers/TfsWorkItemLinkEnricher.cs
-optionsClassFile: 
+classFile: /src/MigrationTools.Clients.AzureDevops.ObjectModel/ProcessorEnrichers/TfsWorkItemLinkEnricher.cs
+optionsClassFile: /src/MigrationTools.Clients.AzureDevops.ObjectModel/ProcessorEnrichers/TfsWorkItemLinkEnricherOptions.cs
diff --git a/...llections/_reference/reference.v2.processorenrichers.tfsworkitemlinkenricher.md b/...llections/_reference/reference.v2.processorenrichers.tfsworkitemlinkenricher.md
@@ -1,16 +1,42 @@
 ---
-optionsClassName: 
-optionsClassFullName: 
-configurationSamples: []
+optionsClassName: TfsWorkItemLinkEnricherOptions
+optionsClassFullName: MigrationTools.Enrichers.TfsWorkItemLinkEnricherOptions
+configurationSamples:
+- name: default
+ description: 
+ code: >-
+ {
+ "$type": "TfsWorkItemLinkEnricherOptions",
+ "Enabled": true,
+ "FilterIfLinkCountMatches": true,
+ "SaveAfterEachLinkIsAdded": false
+ }
+ sampleFor: MigrationTools.Enrichers.TfsWorkItemLinkEnricherOptions
 description: missng XML code comments
 className: TfsWorkItemLinkEnricher
 typeName: ProcessorEnrichers
 architecture: v2
-options: []
+options:
+- parameterName: Enabled
+ type: Boolean
+ description: For internal use
+ defaultValue: missng XML code comments
+- parameterName: FilterIfLinkCountMatches
+ type: Boolean
+ description: Skip validating links if the number of links in the source and the target matches!
+ defaultValue: missng XML code comments
+- parameterName: RefName
+ type: String
+ description: For internal use
+ defaultValue: missng XML code comments
+- parameterName: SaveAfterEachLinkIsAdded
+ type: Boolean
+ description: Save the work item after each link is added. This will slow the migration as it will cause many saves to the TFS database.
+ defaultValue: missng XML code comments
 status: missng XML code comments
 processingTarget: missng XML code comments
-classFile: /src/MigrationTools.Clients.AzureDevops.ObjectModel/Enrichers/TfsWorkItemLinkEnricher.cs
-optionsClassFile: 
+classFile: /src/MigrationTools.Clients.AzureDevops.ObjectModel/ProcessorEnrichers/TfsWorkItemLinkEnricher.cs
+optionsClassFile: /src/MigrationTools.Clients.AzureDevops.ObjectModel/ProcessorEnrichers/TfsWorkItemLinkEnricherOptions.cs
 
 redirectFrom: []
 layout: reference