Skip to content

Commit

Permalink
Change docs for the builder extension methods
Browse files Browse the repository at this point in the history
  • Loading branch information
@Banane9
Banane9 committed Aug 24, 2024
1 parent 7248702 commit 8550d52
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 41 deletions.
40 changes: 20 additions & 20 deletions EnumerableToolkit.Builder/BlockAddingExtensions.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace EnumerableToolkit.Builder
public static class BlockAddingExtensions
{
/// <summary>
/// Adds a building block that concatenates the given items to the end of the current constructed enumerable sequence.
/// Adds a building block with default priority that concatenates the given items to the end of the current constructed enumerable sequence.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -19,7 +19,7 @@ public static IEnumerableBuilder<T> Concat<T>(this IEnumerableBuilder<T> builder
=> builder.Concat(firstItem.Yield().Concat(following));

/// <summary>
/// Adds a building block that concatenates the given sequence to the end of the current constructed enumerable sequence.
/// Adds a building block with default priority that concatenates the given sequence to the end of the current constructed enumerable sequence.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -32,7 +32,7 @@ public static IEnumerableBuilder<T> Concat<T>(this IEnumerableBuilder<T> builder
}

/// <summary>
/// Adds a building block that inserts the given items after every item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given items after every item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -43,7 +43,7 @@ public static IEnumerableBuilder<T> InsertAfterEveryItem<T>(this IEnumerableBuil
=> builder.InsertAfterEveryItem(predicate, firstItem.Yield().Concat(following));

/// <summary>
/// Adds a building block that inserts the given sequence after every item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given sequence after every item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -57,7 +57,7 @@ public static IEnumerableBuilder<T> InsertAfterEveryItem<T>(this IEnumerableBuil
}

/// <summary>
/// Adds a building block that inserts the given items after every item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given items after every item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -68,7 +68,7 @@ public static IEnumerableBuilder<T> InsertAfterEveryItem<T>(this IEnumerableBuil
=> builder.InsertAfterEveryItem(predicate.Wrap(), firstItem.Yield().Concat(following));

/// <summary>
/// Adds a building block that inserts the given sequence after every item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given sequence after every item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -78,7 +78,7 @@ public static IEnumerableBuilder<T> InsertAfterEveryItem<T>(this IEnumerableBuil
=> builder.InsertAfterEveryItem(predicate.Wrap(), sequence);

/// <summary>
/// Adds a building block that inserts the given items after the first item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given items after the first item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -89,7 +89,7 @@ public static IEnumerableBuilder<T> InsertAfterFirstItem<T>(this IEnumerableBuil
=> builder.InsertAfterFirstItem(predicate, firstItem.Yield().Concat(following));

/// <summary>
/// Adds a building block that inserts the given sequence after the first item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given sequence after the first item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -103,7 +103,7 @@ public static IEnumerableBuilder<T> InsertAfterFirstItem<T>(this IEnumerableBuil
}

/// <summary>
/// Adds a building block that inserts the given items after the first item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given items after the first item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -114,7 +114,7 @@ public static IEnumerableBuilder<T> InsertAfterFirstItem<T>(this IEnumerableBuil
=> builder.InsertAfterFirstItem(predicate.Wrap(), firstItem.Yield().Concat(following));

/// <summary>
/// Adds a building block that inserts the given sequence after the first item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given sequence after the first item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -124,7 +124,7 @@ public static IEnumerableBuilder<T> InsertAfterFirstItem<T>(this IEnumerableBuil
=> builder.InsertAfterFirstItem(predicate.Wrap(), sequence);

/// <summary>
/// Adds a building block that inserts the given items before every item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given items before every item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -135,7 +135,7 @@ public static IEnumerableBuilder<T> InsertBeforeEveryItem<T>(this IEnumerableBui
=> builder.InsertBeforeEveryItem(predicate, firstItem.Yield().Concat(following));

/// <summary>
/// Adds a building block that inserts the given sequence before every item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given sequence before every item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -149,7 +149,7 @@ public static IEnumerableBuilder<T> InsertBeforeEveryItem<T>(this IEnumerableBui
}

/// <summary>
/// Adds a building block that inserts the given items before every item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given items before every item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -160,7 +160,7 @@ public static IEnumerableBuilder<T> InsertBeforeEveryItem<T>(this IEnumerableBui
=> builder.InsertBeforeEveryItem(predicate.Wrap(), firstItem.Yield().Concat(following));

/// <summary>
/// Adds a building block that inserts the given sequence before every item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given sequence before every item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -170,7 +170,7 @@ public static IEnumerableBuilder<T> InsertBeforeEveryItem<T>(this IEnumerableBui
=> builder.InsertBeforeEveryItem(predicate.Wrap(), sequence);

/// <summary>
/// Adds a building block that inserts the given items before the first item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given items before the first item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -181,7 +181,7 @@ public static IEnumerableBuilder<T> InsertBeforeFirstItem<T>(this IEnumerableBui
=> builder.InsertBeforeFirstItem(predicate, firstItem.Yield().Concat(following));

/// <summary>
/// Adds a building block that inserts the given sequence before the first item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given sequence before the first item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -195,7 +195,7 @@ public static IEnumerableBuilder<T> InsertBeforeFirstItem<T>(this IEnumerableBui
}

/// <summary>
/// Adds a building block that inserts the given items before the first item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given items before the first item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -206,7 +206,7 @@ public static IEnumerableBuilder<T> InsertBeforeFirstItem<T>(this IEnumerableBui
=> builder.InsertBeforeFirstItem(predicate.Wrap(), firstItem.Yield().Concat(following));

/// <summary>
/// Adds a building block that inserts the given sequence before the first item that matches the given <paramref name="predicate"/>.
/// Adds a building block with default priority that inserts the given sequence before the first item that matches the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -216,7 +216,7 @@ public static IEnumerableBuilder<T> InsertBeforeFirstItem<T>(this IEnumerableBui
=> builder.InsertBeforeFirstItem(predicate.Wrap(), sequence);

/// <summary>
/// Adds a building block that filters the current sequence based on the given <paramref name="predicate"/>.
/// Adds a building block with default priority that filters the current sequence based on the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand All @@ -229,7 +229,7 @@ public static IEnumerableBuilder<T> Where<T>(this IEnumerableBuilder<T> builder,
}

/// <summary>
/// Adds a building block that filters the current sequence based on the given <paramref name="predicate"/>.
/// Adds a building block with default priority that filters the current sequence based on the given <paramref name="predicate"/>.
/// </summary>
/// <typeparam name="T">The type of the items in the generated sequence.</typeparam>
/// <param name="builder">The enumerable builder to add the building block to.</param>
Expand Down
2 changes: 1 addition & 1 deletion EnumerableToolkit.Builder/EnumerableToolkit.Builder.csproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<Title>$(AssemblyTitle)</Title>
<Authors>Banane9</Authors>
<Version>1.2.0</Version>
<Version>2.0.0</Version>
<Description>Adds an EnumerableBuilder to incrementally construct an enumerable sequence out of building blocks.</Description>
<PackageReadmeFile>README.md</PackageReadmeFile>
<PackageProjectUrl>https://github.com/Banane9/EnumerableToolkit</PackageProjectUrl>
Expand Down
Loading

0 comments on commit 8550d52

Please sign in to comment.