Skip to content

Docs: Fix unresolved base documentaion WARNINGS in TestKits #5639

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
merged 1 commit into from
Feb 10, 2022
Merged

Docs: Fix unresolved base documentaion WARNINGS in TestKits #5639

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
4 changes: 2 additions & 2 deletions src/contrib/testkits/Akka.TestKit.Xunit/Internals/AkkaAssertEqualityComparer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public AkkaAssertEqualityComparer(bool skipTypeCheck = false, IEqualityComparer
_innerComparerFactory = () => innerComparer ?? DefaultInnerComparer;
}

/// <inheritdoc/>

public bool Equals(T x, T y)
{
var typeInfo = typeof(T).GetTypeInfo();
Expand Down Expand Up @@ -91,7 +91,7 @@ public bool Equals(T x, T y)
return object.Equals(x, y);
}

/// <inheritdoc/>

public int GetHashCode(T obj) => throw new NotImplementedException();
}
}
2 changes: 1 addition & 1 deletion src/contrib/testkits/Akka.TestKit.Xunit/TestKit.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ protected void InitializeLogger(ActorSystem system)
}
}

/// <inheritdoc/>

public void Dispose()
{
Dispose(true);
Expand Down
2 changes: 1 addition & 1 deletion src/core/Akka.Cluster.TestKit/MultiNodeClusterSpec.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,7 @@ public RoleNameComparer(MultiNodeClusterSpec spec)
_spec = spec;
}

/// <inheritdoc/>

public int Compare(RoleName x, RoleName y)
{
return Member.AddressOrdering.Compare(_spec.GetAddress(x), _spec.GetAddress(y));
Expand Down
2 changes: 1 addition & 1 deletion src/core/Akka.Persistence.TCK/PluginSpec.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public void Subscribe<T>(IActorRef subscriber)
Sys.EventStream.Subscribe(subscriber, typeof (T));
}

/// <inheritdoc/>

public void Dispose()
{
Dispose(true);
Expand Down
70 changes: 35 additions & 35 deletions src/core/Akka.Remote.TestKit/DataTypes.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ public bool Equals(RoleName other)
return string.Equals(Name, other.Name);
}

/// <inheritdoc/>

public override bool Equals(object obj) => obj is RoleName role && Equals(role);

/// <inheritdoc/>

public override int GetHashCode() => (Name != null ? Name.GetHashCode() : 0);

/// <summary>
Expand All @@ -51,7 +51,7 @@ public bool Equals(RoleName other)

public string Name { get; }

/// <inheritdoc/>

public override string ToString() => $"RoleName({Name})";
}

Expand Down Expand Up @@ -82,13 +82,13 @@ public T Msg
get { return _msg; }
}

/// <inheritdoc/>

protected bool Equals(ToClient<T> other)
{
return EqualityComparer<T>.Default.Equals(_msg, other._msg);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
Expand All @@ -97,7 +97,7 @@ public override bool Equals(object obj)
return Equals((ToClient<T>)obj);
}

/// <inheritdoc/>

public override int GetHashCode()
{
return EqualityComparer<T>.Default.GetHashCode(_msg);
Expand Down Expand Up @@ -153,13 +153,13 @@ object IToServer.Msg
get { return _msg; }
}

/// <inheritdoc/>

protected bool Equals(ToServer<T> other)
{
return EqualityComparer<T>.Default.Equals(_msg, other._msg);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
Expand All @@ -168,7 +168,7 @@ public override bool Equals(object obj)
return Equals((ToServer<T>)obj);
}

/// <inheritdoc/>

public override int GetHashCode()
{
return EqualityComparer<T>.Default.GetHashCode(_msg);
Expand Down Expand Up @@ -236,15 +236,15 @@ private bool Equals(Hello other)
return string.Equals(_name, other._name) && Equals(_address, other._address);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
if (ReferenceEquals(this, obj)) return true;
return obj is Hello && Equals((Hello)obj);
}

/// <inheritdoc/>

public override int GetHashCode()
{
unchecked
Expand Down Expand Up @@ -308,15 +308,15 @@ private bool Equals(EnterBarrier other)
return string.Equals(_name, other._name) && _timeout.Equals(other._timeout);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
if (ReferenceEquals(this, obj)) return true;
return obj is EnterBarrier && Equals((EnterBarrier)obj);
}

/// <inheritdoc/>

public override int GetHashCode()
{
unchecked
Expand Down Expand Up @@ -377,15 +377,15 @@ private bool Equals(FailBarrier other)
return string.Equals(_name, other._name);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
if (ReferenceEquals(this, obj)) return true;
return obj is FailBarrier && Equals((FailBarrier)obj);
}

/// <inheritdoc/>

public override int GetHashCode()
{
return (_name != null ? _name.GetHashCode() : 0);
Expand Down Expand Up @@ -440,15 +440,15 @@ bool Equals(BarrierResult other)
return string.Equals(_name, other._name) && _success.Equals(other._success);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
if (ReferenceEquals(this, obj)) return true;
return obj is BarrierResult && Equals((BarrierResult)obj);
}

/// <inheritdoc/>

public override int GetHashCode()
{
unchecked
Expand Down Expand Up @@ -520,15 +520,15 @@ bool Equals(Throttle other)
return Equals(_node, other._node) && Equals(_target, other._target) && Equals(_direction, other._direction) && _rateMBit.Equals(other._rateMBit);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
if (ReferenceEquals(this, obj)) return true;
return obj is Throttle && Equals((Throttle)obj);
}

/// <inheritdoc/>

public override int GetHashCode()
{
unchecked
Expand Down Expand Up @@ -597,15 +597,15 @@ bool Equals(ThrottleMsg other)
return Equals(_target, other._target) && Equals(_direction, other._direction) && _rateMBit.Equals(other._rateMBit);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
if (ReferenceEquals(this, obj)) return true;
return obj is ThrottleMsg && Equals((ThrottleMsg)obj);
}

/// <inheritdoc/>

public override int GetHashCode()
{
unchecked
Expand Down Expand Up @@ -673,15 +673,15 @@ bool Equals(Disconnect other)
return Equals(_node, other._node) && Equals(_target, other._target) && _abort.Equals(other._abort);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
if (ReferenceEquals(this, obj)) return true;
return obj is Disconnect && Equals((Disconnect)obj);
}

/// <inheritdoc/>

public override int GetHashCode()
{
unchecked
Expand Down Expand Up @@ -742,15 +742,15 @@ bool Equals(DisconnectMsg other)
return Equals(_target, other._target) && _abort.Equals(other._abort);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
if (ReferenceEquals(this, obj)) return true;
return obj is DisconnectMsg && Equals((DisconnectMsg)obj);
}

/// <inheritdoc/>

public override int GetHashCode()
{
unchecked
Expand Down Expand Up @@ -808,15 +808,15 @@ bool Equals(Terminate other)
return Equals(_node, other._node) && Equals(_shutdownOrExit, other._shutdownOrExit);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
if (ReferenceEquals(this, obj)) return true;
return obj is Terminate && Equals((Terminate)obj);
}

/// <inheritdoc/>

public override int GetHashCode()
{
unchecked
Expand Down Expand Up @@ -867,15 +867,15 @@ bool Equals(TerminateMsg other)
return Equals(_shutdownOrExit, other._shutdownOrExit);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
if (ReferenceEquals(this, obj)) return true;
return obj is TerminateMsg && Equals((TerminateMsg)obj);
}

/// <inheritdoc/>

public override int GetHashCode()
{
return (_shutdownOrExit != null ? _shutdownOrExit.GetHashCode() : 0);
Expand Down Expand Up @@ -923,15 +923,15 @@ bool Equals(GetAddress other)
return Equals(_node, other._node);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
if (ReferenceEquals(this, obj)) return true;
return obj is GetAddress && Equals((GetAddress)obj);
}

/// <inheritdoc/>

public override int GetHashCode()
{
return (_node != null ? _node.GetHashCode() : 0);
Expand Down Expand Up @@ -986,15 +986,15 @@ bool Equals(AddressReply other)
return Equals(_node, other._node) && Equals(_addr, other._addr);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
if (ReferenceEquals(this, obj)) return true;
return obj is AddressReply && Equals((AddressReply)obj);
}

/// <inheritdoc/>

public override int GetHashCode()
{
unchecked
Expand Down Expand Up @@ -1059,15 +1059,15 @@ bool Equals(Remove other)
return Equals(_node, other._node);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
if (ReferenceEquals(this, obj)) return true;
return obj is Remove && Equals((Remove)obj);
}

/// <inheritdoc/>

public override int GetHashCode()
{
return (_node != null ? _node.GetHashCode() : 0);
Expand Down
2 changes: 1 addition & 1 deletion src/core/Akka.Remote.TestKit/MultiNodeSpec.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -678,7 +678,7 @@ protected ActorSystem StartNewSystem()
return system;
}

/// <inheritdoc/>

public void Dispose()
{
Dispose(true);
Expand Down