Skip to content

Commit

Permalink
Docs: removed inheritdoc tags (#5581)
Browse files Browse the repository at this point in the history
* Fix base docs issue along `Actor` path

* Removed `inheritdoc`
  • Loading branch information
eaba authored Feb 7, 2022
1 parent a4432ed commit e54ff74
Show file tree
Hide file tree
Showing 19 changed files with 61 additions and 88 deletions.
1 change: 0 additions & 1 deletion src/core/Akka/Actor/ActorBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@ public Failure(Exception cause, object state)
State = state;
}

/// <inheritdoc/>
public override string ToString()
=> State is null ? $"Failure: {Cause}" : $"Failure[{State}]: {Cause}";
}
Expand Down
8 changes: 0 additions & 8 deletions src/core/Akka/Actor/ActorPath.cs
Original file line number Diff line number Diff line change
Expand Up @@ -64,21 +64,18 @@ public ISurrogated FromSurrogate(ActorSystem system)

#region Equality

/// <inheritdoc/>
public bool Equals(Surrogate other)
{
if (other is null) return false;
return ReferenceEquals(this, other) || StringComparer.Ordinal.Equals(Path, other.Path);
}

/// <inheritdoc/>
public bool Equals(ActorPath other)
{
if (other is null) return false;
return StringComparer.Ordinal.Equals(Path, other.ToSerializationFormat());
}

/// <inheritdoc/>
public override bool Equals(object obj)
{
if (obj is null) return false;
Expand All @@ -87,7 +84,6 @@ public override bool Equals(object obj)
return Equals(obj as Surrogate);
}

/// <inheritdoc/>
public override int GetHashCode()
{
return Path.GetHashCode();
Expand Down Expand Up @@ -262,7 +258,6 @@ internal IReadOnlyList<string> ElementsWithUid
[JsonIgnore]
public ActorPath Root => ParentOf(0);

/// <inheritdoc/>
public bool Equals(ActorPath other)
{
if (other is null || _depth != other._depth)
Expand Down Expand Up @@ -290,7 +285,6 @@ public bool Equals(ActorPath other)
}
}

/// <inheritdoc/>
public int CompareTo(ActorPath other)
{
if (_depth == 0)
Expand Down Expand Up @@ -613,7 +607,6 @@ public string ToStringWithoutAddress()
return Join(ReadOnlySpan<char>.Empty);
}

/// <inheritdoc/>
public override string ToString()
{
return Join(_address.ToString().AsSpan());
Expand Down Expand Up @@ -650,7 +643,6 @@ public override int GetHashCode()
}
}

/// <inheritdoc/>
public override bool Equals(object obj)
{
return Equals(obj as ActorPath);
Expand Down
10 changes: 4 additions & 6 deletions src/core/Akka/Actor/ActorRef.cs
Original file line number Diff line number Diff line change
Expand Up @@ -284,14 +284,14 @@ public void Tell(object message, IActorRef sender)
/// <param name="sender">TBD</param>
protected abstract void TellInternal(object message, IActorRef sender);

/// <inheritdoc/>

public override string ToString()
{
if (Path.Uid == ActorCell.UndefinedUid) return $"[{Path}]";
return $"[{Path}#{Path.Uid}]";
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (obj is IActorRef other)
Expand All @@ -300,7 +300,6 @@ public override bool Equals(object obj)
return false;
}

/// <inheritdoc/>
public override int GetHashCode()
{
unchecked
Expand All @@ -312,7 +311,6 @@ public override int GetHashCode()
}
}

/// <inheritdoc/>
/// <exception cref="ArgumentException">
/// This exception is thrown if the given <paramref name="obj"/> isn't an <see cref="IActorRef"/>.
/// </exception>
Expand Down Expand Up @@ -344,7 +342,7 @@ public bool Equals(IActorRef other)
&& Path.Equals(other.Path);
}

/// <inheritdoc/>

public int CompareTo(IActorRef other)
{
if (other is null) return 1;
Expand Down Expand Up @@ -901,7 +899,7 @@ public Enumerable(IEnumerator<T> enumerator)
_enumerator = enumerator;
}

/// <inheritdoc/>

public IEnumerator<T> GetEnumerator()
{
return _enumerator;
Expand Down
37 changes: 18 additions & 19 deletions src/core/Akka/Actor/ActorSelection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,6 @@ EmptyLocalActorRef EmptyRef(){
}
}

/// <inheritdoc/>
public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
Expand All @@ -298,13 +297,13 @@ public override bool Equals(object obj)
return Equals((ActorSelection)obj);
}

/// <inheritdoc/>

protected bool Equals(ActorSelection other)
{
return Equals(Anchor, other.Anchor) && Equals(PathString, other.PathString);
}

/// <inheritdoc/>

public override int GetHashCode()
{
unchecked
Expand All @@ -313,7 +312,7 @@ public override int GetHashCode()
}
}

/// <inheritdoc/>

public override string ToString()
{
var builder = new StringBuilder();
Expand Down Expand Up @@ -358,7 +357,7 @@ public ActorSelectionMessage(object message, SelectionPathElement[] elements, bo
/// </summary>
public bool WildCardFanOut { get; }

/// <inheritdoc/>

public override string ToString()
{
var elements = string.Join<SelectionPathElement>("/", Elements);
Expand Down Expand Up @@ -405,13 +404,13 @@ public SelectChildName(string name)
/// </summary>
public string Name { get; }

/// <inheritdoc/>

protected bool Equals(SelectChildName other)
{
return string.Equals(Name, other.Name);
}

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
Expand All @@ -420,10 +419,10 @@ public override bool Equals(object obj)
return Equals((SelectChildName)obj);
}

/// <inheritdoc/>

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

/// <inheritdoc/>

public override string ToString() => Name;
}

Expand All @@ -446,10 +445,10 @@ public SelectChildPattern(string patternStr)
/// </summary>
public string PatternStr { get; }

/// <inheritdoc/>

protected bool Equals(SelectChildPattern other) => string.Equals(PatternStr, other.PatternStr);

/// <inheritdoc/>

public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
Expand All @@ -458,16 +457,16 @@ public override bool Equals(object obj)
return Equals((SelectChildPattern)obj);
}

/// <inheritdoc/>

public override int GetHashCode() => PatternStr?.GetHashCode() ?? 0;

/// <inheritdoc/>

public override string ToString() => PatternStr;
}

public class SelectChildRecursive : SelectionPathElement
{
/// <inheritdoc/>

public override bool Equals(object obj)
{
if (obj is null) return false;
Expand All @@ -481,10 +480,10 @@ public override bool Equals(object obj)
/// </summary>
public static readonly SelectChildRecursive Instance = new SelectChildRecursive();

/// <inheritdoc/>

public override int GetHashCode() => "**".GetHashCode();

/// <inheritdoc/>

public override string ToString() => "**";

}
Expand All @@ -499,13 +498,13 @@ public class SelectParent : SelectionPathElement
/// </summary>
public static readonly SelectParent Instance = new SelectParent();

/// <inheritdoc/>

public override bool Equals(object obj) => !ReferenceEquals(obj, null) && obj is SelectParent;

/// <inheritdoc/>

public override int GetHashCode() => nameof(SelectParent).GetHashCode();

/// <inheritdoc/>

public override string ToString() => "..";
}
}
1 change: 0 additions & 1 deletion src/core/Akka/Actor/ActorSystem.cs
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,6 @@ private static ActorSystem CreateAndStartSystem(string name, Config withFallback

private bool _isDisposed; //Automatically initialized to false;

/// <inheritdoc/>
public void Dispose()
{
Dispose(true);
Expand Down
6 changes: 2 additions & 4 deletions src/core/Akka/Actor/Address.cs
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,6 @@ public int CompareTo(Address other)
return Comparer.Compare(this, other);
}

/// <inheritdoc/>
public override string ToString()
{
if (_toString == null)
Expand All @@ -146,18 +145,17 @@ public override string ToString()
return _toString;
}

/// <inheritdoc/>

public bool Equals(Address other)
{
if (ReferenceEquals(null, other)) return false;
if (ReferenceEquals(this, other)) return true;
return Port == other.Port && string.Equals(Host, other.Host) && string.Equals(System, other.System) && string.Equals(Protocol, other.Protocol);
}

/// <inheritdoc/>

public override bool Equals(object obj) => Equals(obj as Address);

/// <inheritdoc/>
public override int GetHashCode()
{
unchecked
Expand Down
1 change: 0 additions & 1 deletion src/core/Akka/Actor/Cancellation/Cancelable.cs
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,6 @@ private void ThrowIfDisposed()
private bool _isDisposed; //Automatically initialized to false;


/// <inheritdoc/>
public void Dispose()
{
Dispose(true);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ private ChildNameReserved() {/* Intentionally left blank */}
/// TBD
/// </summary>
public static ChildNameReserved Instance { get { return _instance; } }
/// <inheritdoc/>

public override string ToString()
{
return "Name Reserved";
Expand Down
4 changes: 2 additions & 2 deletions src/core/Akka/Actor/Extensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -195,13 +195,13 @@ public T Get(ActorSystem system)
/// <returns>The extension created using the given actor system.</returns>
public abstract T CreateExtension(ExtendedActorSystem system);

/// <inheritdoc/>

public override bool Equals(object obj)
{
return obj is T;
}

/// <inheritdoc/>

public override int GetHashCode()
{
return typeof (T).GetHashCode();
Expand Down
Loading

0 comments on commit e54ff74

Please sign in to comment.