Fix broken links in documentation comments

App-vNext · martintmk · Jan 22, 2024 · Jan 22, 2024 · Jan 22, 2024 · Jan 22, 2024
commit 1de5a1263b1f72d9d34d87af04efe14a510eb043
diff --git a/src/Polly.Core/Simmy/Fault/FaultGenerator.cs b/src/Polly.Core/Simmy/Fault/FaultGenerator.cs
@@ -10,7 +10,7 @@ namespace Polly.Simmy.Fault;
 /// A generator for creating faults (exceptions) using registered delegate functions.
 /// </summary>
 /// <remarks>
-/// An instance of this class can be assigned to the <see cref="FaultStrategyOptions.FaultGenerator"/> property.
+/// An instance of this class can be assigned to the <see cref="ChaosFaultStrategyOptions.FaultGenerator"/> property.
 /// </remarks>
 public sealed class FaultGenerator
 {
@@ -69,7 +69,7 @@ public FaultGenerator AddException<TException>(int weight = DefaultWeight)
     }
 
     /// <summary>
-    /// Provides an implicit conversion from <see cref="FaultGenerator"/> to a delegate compatible with <see cref="FaultStrategyOptions.FaultGenerator"/>.
+    /// Provides an implicit conversion from <see cref="FaultGenerator"/> to a delegate compatible with <see cref="ChaosFaultStrategyOptions.FaultGenerator"/>.
     /// </summary>
     /// <param name="generator">The instance of <see cref="FaultGenerator"/>.</param>
     [EditorBrowsable(EditorBrowsableState.Never)]

diff --git a/src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs b/src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs
        "Trimming",
        "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code",
        Justification = "All options members preserved.")]
    public static TBuilder AddChaosFault<TBuilder>(this TBuilder builder, ChaosFaultStrategyOptions options)
        where TBuilder : ResiliencePipelineBuilderBase
    {
        Guard.NotNull(builder);
diff --git a/src/Polly.Core/PublicAPI.Unshipped.txt b/src/Polly.Core/PublicAPI.Unshipped.txt
 static Polly.Simmy.ChaosBehaviorPipelineBuilderExtensions.AddChaosBehavior<TBuilder>(this TBuilder! builder, Polly.Simmy.Behavior.ChaosBehaviorStrategyOptions! options) -> TBuilder!
 static Polly.Simmy.Fault.FaultGenerator.implicit operator System.Func<Polly.Simmy.Fault.FaultGeneratorArguments, System.Threading.Tasks.ValueTask<System.Exception?>>!(Polly.Simmy.Fault.FaultGenerator! generator) -> System.Func<Polly.Simmy.Fault.FaultGeneratorArguments, System.Threading.Tasks.ValueTask<System.Exception?>>!
 static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, double injectionRate, System.Func<System.Exception?>! faultGenerator) -> TBuilder!
 static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!
 static Polly.Simmy.LatencyPipelineBuilderExtensions.AddChaosLatency<TBuilder>(this TBuilder! builder, double injectionRate, System.TimeSpan latency) -> TBuilder!
 static Polly.Simmy.LatencyPipelineBuilderExtensions.AddChaosLatency<TBuilder>(this TBuilder! builder, Polly.Simmy.Latency.LatencyStrategyOptions! options) -> TBuilder!
 static Polly.Simmy.OutcomePipelineBuilderExtensions.AddChaosResult<TResult>(this Polly.ResiliencePipelineBuilder<TResult>! builder, double injectionRate, System.Func<TResult?>! resultGenerator) -> Polly.ResiliencePipelineBuilder<TResult>!
	"Trimming",
	"IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code",
	Justification = "All options members preserved.")]
	public static TBuilder AddChaosFault<TBuilder>(this TBuilder builder, ChaosFaultStrategyOptions options)
Check warning on line 42 in src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs GitHub Actions / publish-docs `Symbol 'AddChaosFault<TBuilder>' is not part of the declared public API (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 42 in src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs GitHub Actions / publish-docs `Symbol 'AddChaosFault<TBuilder>' is not part of the declared public API (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 42 in src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs GitHub Actions / publish-docs `Symbol 'AddChaosFault<TBuilder>' is not part of the declared public API (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 42 in src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs GitHub Actions / publish-docs `Symbol 'AddChaosFault<TBuilder>' is not part of the declared public API (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 42 in src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs GitHub Actions / publish-docs `Symbol 'AddChaosFault<TBuilder>' is not part of the declared public API (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check failure on line 42 in src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs GitHub Actions / windows-latest `Symbol 'AddChaosFault<TBuilder>' is not part of the declared public API (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check failure on line 42 in src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs GitHub Actions / windows-latest `Symbol 'AddChaosFault<TBuilder>' is not part of the declared public API (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check failure on line 42 in src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs GitHub Actions / windows-latest `Symbol 'AddChaosFault<TBuilder>' is not part of the declared public API (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check failure on line 42 in src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs GitHub Actions / windows-latest `Symbol 'AddChaosFault<TBuilder>' is not part of the declared public API (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check failure on line 42 in src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs GitHub Actions / windows-latest `Symbol 'AddChaosFault<TBuilder>' is not part of the declared public API (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 42 in src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs GitHub Actions / code-ql (csharp) `Symbol 'AddChaosFault<TBuilder>' is not part of the declared public API (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 42 in src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs GitHub Actions / code-ql (csharp) `Symbol 'AddChaosFault<TBuilder>' is not part of the declared public API (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 42 in src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs GitHub Actions / code-ql (csharp) `Symbol 'AddChaosFault<TBuilder>' is not part of the declared public API (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 42 in src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs GitHub Actions / code-ql (csharp) `Symbol 'AddChaosFault<TBuilder>' is not part of the declared public API (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 42 in src/Polly.Core/Simmy/Fault/ChaosFaultPipelineBuilderExtensions.cs GitHub Actions / code-ql (csharp) `Symbol 'AddChaosFault<TBuilder>' is not part of the declared public API (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)`
	where TBuilder : ResiliencePipelineBuilderBase
	{
	Guard.NotNull(builder);
	static Polly.Simmy.ChaosBehaviorPipelineBuilderExtensions.AddChaosBehavior<TBuilder>(this TBuilder! builder, Polly.Simmy.Behavior.ChaosBehaviorStrategyOptions! options) -> TBuilder!
	static Polly.Simmy.Fault.FaultGenerator.implicit operator System.Func<Polly.Simmy.Fault.FaultGeneratorArguments, System.Threading.Tasks.ValueTask<System.Exception?>>!(Polly.Simmy.Fault.FaultGenerator! generator) -> System.Func<Polly.Simmy.Fault.FaultGeneratorArguments, System.Threading.Tasks.ValueTask<System.Exception?>>!
	static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, double injectionRate, System.Func<System.Exception?>! faultGenerator) -> TBuilder!
	static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!
Check warning on line 113 in src/Polly.Core/PublicAPI.Unshipped.txt GitHub Actions / publish-docs `Symbol 'static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!' is part of the declared API, but is either not public or could not be found (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 113 in src/Polly.Core/PublicAPI.Unshipped.txt GitHub Actions / publish-docs `Symbol 'static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!' is part of the declared API, but is either not public or could not be found (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 113 in src/Polly.Core/PublicAPI.Unshipped.txt GitHub Actions / publish-docs `Symbol 'static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!' is part of the declared API, but is either not public or could not be found (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 113 in src/Polly.Core/PublicAPI.Unshipped.txt GitHub Actions / publish-docs `Symbol 'static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!' is part of the declared API, but is either not public or could not be found (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 113 in src/Polly.Core/PublicAPI.Unshipped.txt GitHub Actions / publish-docs `Symbol 'static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!' is part of the declared API, but is either not public or could not be found (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check failure on line 113 in src/Polly.Core/PublicAPI.Unshipped.txt GitHub Actions / windows-latest `Symbol 'static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!' is part of the declared API, but is either not public or could not be found (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check failure on line 113 in src/Polly.Core/PublicAPI.Unshipped.txt GitHub Actions / windows-latest `Symbol 'static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!' is part of the declared API, but is either not public or could not be found (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check failure on line 113 in src/Polly.Core/PublicAPI.Unshipped.txt GitHub Actions / windows-latest `Symbol 'static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!' is part of the declared API, but is either not public or could not be found (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check failure on line 113 in src/Polly.Core/PublicAPI.Unshipped.txt GitHub Actions / windows-latest `Symbol 'static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!' is part of the declared API, but is either not public or could not be found (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check failure on line 113 in src/Polly.Core/PublicAPI.Unshipped.txt GitHub Actions / windows-latest `Symbol 'static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!' is part of the declared API, but is either not public or could not be found (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 113 in src/Polly.Core/PublicAPI.Unshipped.txt GitHub Actions / code-ql (csharp) `Symbol 'static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!' is part of the declared API, but is either not public or could not be found (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 113 in src/Polly.Core/PublicAPI.Unshipped.txt GitHub Actions / code-ql (csharp) `Symbol 'static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!' is part of the declared API, but is either not public or could not be found (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 113 in src/Polly.Core/PublicAPI.Unshipped.txt GitHub Actions / code-ql (csharp) `Symbol 'static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!' is part of the declared API, but is either not public or could not be found (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 113 in src/Polly.Core/PublicAPI.Unshipped.txt GitHub Actions / code-ql (csharp) `Symbol 'static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!' is part of the declared API, but is either not public or could not be found (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)` Check warning on line 113 in src/Polly.Core/PublicAPI.Unshipped.txt GitHub Actions / code-ql (csharp) `Symbol 'static Polly.Simmy.ChaosFaultPipelineBuilderExtensions.AddChaosFault<TBuilder>(this TBuilder! builder, Polly.Simmy.Fault.FaultStrategyOptions! options) -> TBuilder!' is part of the declared API, but is either not public or could not be found (https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md)`
	static Polly.Simmy.LatencyPipelineBuilderExtensions.AddChaosLatency<TBuilder>(this TBuilder! builder, double injectionRate, System.TimeSpan latency) -> TBuilder!
	static Polly.Simmy.LatencyPipelineBuilderExtensions.AddChaosLatency<TBuilder>(this TBuilder! builder, Polly.Simmy.Latency.LatencyStrategyOptions! options) -> TBuilder!
	static Polly.Simmy.OutcomePipelineBuilderExtensions.AddChaosResult<TResult>(this Polly.ResiliencePipelineBuilder<TResult>! builder, double injectionRate, System.Func<TResult?>! resultGenerator) -> Polly.ResiliencePipelineBuilder<TResult>!