Skip to content

Commit 110fcc7

Browse files
committed
doc - Merge.cs: add description for newly added parameter keepManufacturer in XML doc
1 parent aabfdfa commit 110fcc7

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

src/CycloneDX.Utils/Merge.cs

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
using CycloneDX.Models;
2323
using CycloneDX.Models.Vulnerabilities;
2424
using CycloneDX.Utils.Exceptions;
25-
using Json.Schema;
2625

2726
namespace CycloneDX.Utils
2827
{
@@ -116,7 +115,10 @@ public static Bom FlatMerge(Bom bom1, Bom bom2)
116115
/// </summary>
117116
/// <param name="bom1"></param>
118117
/// <param name="bom2"></param>
119-
/// <param name="keepManufacturer"></param>
118+
/// <param name="keepManufacturer">
119+
/// Keep the first found manufacturer in a BOM. Without this option
120+
/// all manufacturers are discarded.
121+
/// </param>
120122
/// <returns></returns>
121123
public static Bom FlatMerge(Bom bom1, Bom bom2, bool keepManufacturer)
122124
{
@@ -253,7 +255,10 @@ public static Bom FlatMerge(IEnumerable<Bom> boms)
253255
/// maintained refer to the <c>HierarchicalMerge</c> method.
254256
/// </summary>
255257
/// <param name="boms"></param>
256-
/// <param name="keepManufacturer"></param>
258+
/// <param name="keepManufacturer">
259+
/// Keep the first found manufacturer in a BOM. Without this option
260+
/// all manufacturers are discarded.
261+
/// </param>
257262
/// <returns></returns>
258263
public static Bom FlatMerge(IEnumerable<Bom> boms, bool keepManufacturer)
259264
{
@@ -291,7 +296,10 @@ public static Bom FlatMerge(IEnumerable<Bom> boms, Component bomSubject)
291296
/// </summary>
292297
/// <param name="boms"></param>
293298
/// <param name="bomSubject"></param>
294-
/// <param name="keepManufacturer"></param>
299+
/// <param name="keepManufacturer">
300+
/// Keep the first found manufacturer in a BOM. Without this option
301+
/// all manufacturers are discarded.
302+
/// </param>
295303
/// <returns></returns>
296304
public static Bom FlatMerge(IEnumerable<Bom> boms, Component bomSubject, bool keepManufacturer)
297305
{

0 commit comments

Comments
 (0)