Skip to content

Commit 11a4fa3

Browse files
committed
Add some comments
1 parent da66076 commit 11a4fa3

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/MigrationTools.Clients.TfsObjectModel/Tools/FieldMappingTool/FieldMappingToolExtentions.cs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,15 @@ public static IEnumerable<TFieldMap> GetFieldMaps<TFieldMap>(
2727
.Cast<TFieldMap>();
2828
}
2929

30+
/// <summary>
31+
/// Return defined field maps of type <see cref="FieldToFieldMap"/> for work item type <paramref name="witName"/>,
32+
/// which are defined for source field <paramref name="sourceFieldReferenceName"/>. If <paramref name="mapMode"/>
33+
/// is set, only field maps with given mode are returned.
34+
/// </summary>
35+
/// <param name="fieldMappingTool">Field mapping tool.</param>
36+
/// <param name="witName">Work item type name.</param>
37+
/// <param name="sourceFieldReferenceName">Source field reference name.</param>
38+
/// <param name="mapMode">Field map mode.</param>
3039
public static IEnumerable<FieldToFieldMap> GetFieldToFieldMaps(
3140
this IFieldMappingTool fieldMappingTool,
3241
string witName,
@@ -41,6 +50,12 @@ public static IEnumerable<FieldToFieldMap> GetFieldToFieldMaps(
4150
: allMaps;
4251
}
4352

53+
/// <summary>
54+
/// Returns all all defined field maps in <see cref="FieldToFieldMultiMap"/> for source field <paramref name="sourceFieldReferenceName"/>.
55+
/// </summary>
56+
/// <param name="fieldMappingTool">Field mapping tool.</param>
57+
/// <param name="witName">Work item type name.</param>
58+
/// <param name="sourceFieldReferenceName">Source field reference name.</param>
4459
public static IEnumerable<(string sourceFieldName, string targetFieldName)> GetFieldToFieldMultiMaps(
4560
this IFieldMappingTool fieldMappingTool,
4661
string witName,

0 commit comments

Comments
 (0)