Skip to content
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

Jump to bottom

Docs: Fix Invalid cref values #5646

Merged
merged 1 commit into from
Feb 11, 2022
Merged

Docs: Fix Invalid cref values #5646

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion src/contrib/cluster/Akka.Cluster.Tools/PublishSubscribe/DistributedPubSubSettings.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public static DistributedPubSubSettings Create(Config config)
public string Role { get; }

/// <summary>
/// The routing logic to use for <see cref="DistributedPubSubMediator.Send"/>.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a "real" invalid cref value issue

/// The routing logic to use for <see cref="DistributedPubSubMediator"/>.
/// </summary>
public RoutingLogic RoutingLogic { get; }

Expand Down
2 changes: 1 addition & 1 deletion src/contrib/cluster/Akka.DistributedData/Internal/Internal.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -886,7 +886,7 @@ private NoDelta() { }
/// and thereby violating <see cref="IRequireCausualDeliveryOfDeltas"/>.
///
/// This is used as a placeholder for such `null` delta. It's filtered out
/// in <see cref="DeltaPropagationSelector.CreateDeltaPropagation(ImmutableDictionary{string, Tuple{IReplicatedData, long, long}})"/>, i.e. never sent to the other replicas.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a "real" invalid cref value issue

/// in <see cref="DeltaPropagationSelector.CreateDeltaPropagation"/>, i.e. never sent to the other replicas.
/// </summary>
public static readonly IReplicatedDelta NoDeltaPlaceholder = NoDelta.Instance;

Expand Down
4 changes: 2 additions & 2 deletions src/contrib/cluster/Akka.DistributedData/Replicator.Messages.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,10 +154,10 @@ public interface IGetResponse : INoSerializationVerificationNeeded

/// <summary>
/// Tries to return a result of the request, given a replicated collection
/// <paramref name="key"/> used when sending a <see cref="Replicator.Get"/> request.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a "real" invalid cref value issue

/// <paramref name="key"/> used when sending a <see cref="Replicator"/> request.
/// </summary>
/// <typeparam name="T">Replicated data.</typeparam>
/// <param name="key">Key send originally with a <see cref="Replicator.Get"/> request.</param>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a "real" invalid cref value issue

/// <param name="key">Key send originally with a <see cref="Replicator"/> request.</param>
/// <exception cref="KeyNotFoundException">Thrown when no value for provided <paramref name="key"/> was found.</exception>
/// <exception cref="TimeoutException">Thrown when response with given consistency didn't arrive within specified timeout.</exception>
/// <returns></returns>
Expand Down