Skip to content

Improve pipeline factory docs #251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kzu merged 1 commit into from
Sep 30, 2026
Merged

Improve pipeline factory docs #251

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/Stunts/BehaviorPipelineFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@
namespace Stunts
{
/// <summary>
/// Provides the global <see cref="Default"/> and <see cref="LocalDefault"/>
/// behavior pipeline factory used when creating new stunts.
/// Provides the global <see cref="Default"/> behavior pipeline factory used when creating new stunts.
/// </summary>
/// <remarks>
/// Stunts will use <see cref="Default"/>.<see cref="IBehaviorPipelineFactory.CreatePipeline{TStunt}"/>
/// whenever a new stunt is instantiated, to initialize a behavior pipeline that is invoked in the
/// constructor itself, even before further configuration can be performed on the created instance.
/// <para>
/// This is typically only needed for advanced scenarios.
/// This is typically only needed for advanced scenarios. For testing, an ambient <see cref="IBehaviorPipelineFactory"/>
/// can be set via <see cref="UseAmbient(IBehaviorPipelineFactory)"/> to override the global default for the
/// current execution context.
/// </para>
/// </remarks>
public static class BehaviorPipelineFactory
Expand Down
Loading