You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by pt...@apache.org on 2017/08/29 13:56:34 UTC
ignite git commit: IGNITE-6215 .NET: Avoid inheritdoc on public APIs
Repository: ignite
Updated Branches:
refs/heads/master 2cf12603c -> 9c7853164
IGNITE-6215 .NET: Avoid inheritdoc on public APIs
Project: http://git-wip-us.apache.org/repos/asf/ignite/repo
Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/9c785316
Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/9c785316
Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/9c785316
Branch: refs/heads/master
Commit: 9c7853164d990d5e93acfb5d09158a6545ac6820
Parents: 2cf1260
Author: Pavel Tupitsyn <pt...@apache.org>
Authored: Tue Aug 29 16:56:19 2017 +0300
Committer: Pavel Tupitsyn <pt...@apache.org>
Committed: Tue Aug 29 16:56:19 2017 +0300
----------------------------------------------------------------------
.../Cache/CachePartialUpdateException.cs | 9 +++++-
.../Apache.Ignite.Core/Common/IgniteGuid.cs | 31 +++++++++++++++++---
.../Datastream/StreamTransformer.cs | 6 +++-
.../Datastream/StreamVisitor.cs | 6 +++-
.../Apache.Ignite.Core/Events/JobEvent.cs | 6 ++--
.../Apache.Ignite.Core/Events/TaskEvent.cs | 4 ++-
.../Apache.Ignite.Core/Impl/Cache/CacheEntry.cs | 31 ++++++++++++++++----
.../Services/ServiceInvocationException.cs | 9 +++++-
8 files changed, 85 insertions(+), 17 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/ignite/blob/9c785316/modules/platforms/dotnet/Apache.Ignite.Core/Cache/CachePartialUpdateException.cs
----------------------------------------------------------------------
diff --git a/modules/platforms/dotnet/Apache.Ignite.Core/Cache/CachePartialUpdateException.cs b/modules/platforms/dotnet/Apache.Ignite.Core/Cache/CachePartialUpdateException.cs
index 484fceb..0cc4192 100644
--- a/modules/platforms/dotnet/Apache.Ignite.Core/Cache/CachePartialUpdateException.cs
+++ b/modules/platforms/dotnet/Apache.Ignite.Core/Cache/CachePartialUpdateException.cs
@@ -111,7 +111,14 @@ namespace Apache.Ignite.Core.Cache
return _failedKeys == null ? null : _failedKeys.Cast<T>();
}
- /** <inheritdoc /> */
+ /// <summary>
+ /// When overridden in a derived class, sets the <see cref="SerializationInfo" />
+ /// with information about the exception.
+ /// </summary>
+ /// <param name="info">The <see cref="SerializationInfo" /> that holds the serialized object data
+ /// about the exception being thrown.</param>
+ /// <param name="context">The <see cref="StreamingContext" /> that contains contextual information
+ /// about the source or destination.</param>
[SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods")]
public override void GetObjectData(SerializationInfo info, StreamingContext context)
{
http://git-wip-us.apache.org/repos/asf/ignite/blob/9c785316/modules/platforms/dotnet/Apache.Ignite.Core/Common/IgniteGuid.cs
----------------------------------------------------------------------
diff --git a/modules/platforms/dotnet/Apache.Ignite.Core/Common/IgniteGuid.cs b/modules/platforms/dotnet/Apache.Ignite.Core/Common/IgniteGuid.cs
index b686f9b..d116a750 100644
--- a/modules/platforms/dotnet/Apache.Ignite.Core/Common/IgniteGuid.cs
+++ b/modules/platforms/dotnet/Apache.Ignite.Core/Common/IgniteGuid.cs
@@ -76,20 +76,38 @@ namespace Apache.Ignite.Core.Common
get { return _localId; }
}
- /** <inheritDoc /> */
+ /// <summary>
+ /// Indicates whether the current object is equal to another object of the same type.
+ /// </summary>
+ /// <param name="other">An object to compare with this object.</param>
+ /// <returns>
+ /// true if the current object is equal to the <paramref name="other" /> parameter; otherwise, false.
+ /// </returns>
public bool Equals(IgniteGuid other)
{
return _globalId.Equals(other._globalId) && _localId == other._localId;
}
- /** <inheritDoc /> */
+ /// <summary>
+ /// Determines whether the specified <see cref="object" />, is equal to this instance.
+ /// </summary>
+ /// <param name="obj">The <see cref="object" /> to compare with this instance.</param>
+ /// <returns>
+ /// <c>true</c> if the specified <see cref="object" /> is equal to this instance; otherwise, <c>false</c>.
+ /// </returns>
public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
return obj is IgniteGuid && Equals((IgniteGuid) obj);
}
- /** <inheritDoc /> */
+ /// <summary>
+ /// Returns a hash code for this instance.
+ /// </summary>
+ /// <returns>
+ /// A hash code for this instance, suitable for use in hashing algorithms and
+ /// data structures like a hash table.
+ /// </returns>
public override int GetHashCode()
{
unchecked
@@ -98,7 +116,12 @@ namespace Apache.Ignite.Core.Common
}
}
- /** <inheritDoc /> */
+ /// <summary>
+ /// Returns a <see cref="string" /> that represents this instance.
+ /// </summary>
+ /// <returns>
+ /// A <see cref="string" /> that represents this instance.
+ /// </returns>
public override string ToString()
{
return string.Format(CultureInfo.InvariantCulture,
http://git-wip-us.apache.org/repos/asf/ignite/blob/9c785316/modules/platforms/dotnet/Apache.Ignite.Core/Datastream/StreamTransformer.cs
----------------------------------------------------------------------
diff --git a/modules/platforms/dotnet/Apache.Ignite.Core/Datastream/StreamTransformer.cs b/modules/platforms/dotnet/Apache.Ignite.Core/Datastream/StreamTransformer.cs
index 1735c3b..7413aee 100644
--- a/modules/platforms/dotnet/Apache.Ignite.Core/Datastream/StreamTransformer.cs
+++ b/modules/platforms/dotnet/Apache.Ignite.Core/Datastream/StreamTransformer.cs
@@ -50,7 +50,11 @@ namespace Apache.Ignite.Core.Datastream
_proc = proc;
}
- /** <inheritdoc /> */
+ /// <summary>
+ /// Updates cache with batch of entries.
+ /// </summary>
+ /// <param name="cache">Cache.</param>
+ /// <param name="entries">Entries.</param>
[SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods")]
public void Receive(ICache<TK, TV> cache, ICollection<ICacheEntry<TK, TV>> entries)
{
http://git-wip-us.apache.org/repos/asf/ignite/blob/9c785316/modules/platforms/dotnet/Apache.Ignite.Core/Datastream/StreamVisitor.cs
----------------------------------------------------------------------
diff --git a/modules/platforms/dotnet/Apache.Ignite.Core/Datastream/StreamVisitor.cs b/modules/platforms/dotnet/Apache.Ignite.Core/Datastream/StreamVisitor.cs
index 071f7a3..ba28fa2 100644
--- a/modules/platforms/dotnet/Apache.Ignite.Core/Datastream/StreamVisitor.cs
+++ b/modules/platforms/dotnet/Apache.Ignite.Core/Datastream/StreamVisitor.cs
@@ -46,7 +46,11 @@ namespace Apache.Ignite.Core.Datastream
_action = action;
}
- /** <inheritdoc /> */
+ /// <summary>
+ /// Updates cache with batch of entries.
+ /// </summary>
+ /// <param name="cache">Cache.</param>
+ /// <param name="entries">Entries.</param>
[SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods")]
public void Receive(ICache<TK, TV> cache, ICollection<ICacheEntry<TK, TV>> entries)
{
http://git-wip-us.apache.org/repos/asf/ignite/blob/9c785316/modules/platforms/dotnet/Apache.Ignite.Core/Events/JobEvent.cs
----------------------------------------------------------------------
diff --git a/modules/platforms/dotnet/Apache.Ignite.Core/Events/JobEvent.cs b/modules/platforms/dotnet/Apache.Ignite.Core/Events/JobEvent.cs
index 878562f..af62a78 100644
--- a/modules/platforms/dotnet/Apache.Ignite.Core/Events/JobEvent.cs
+++ b/modules/platforms/dotnet/Apache.Ignite.Core/Events/JobEvent.cs
@@ -90,8 +90,10 @@ namespace Apache.Ignite.Core.Events
/// </summary>
public Guid? TaskSubjectId { get { return _taskSubjectId; } }
- /** <inheritDoc /> */
- public override string ToShortString()
+ /// <summary>
+ /// Gets shortened version of ToString result.
+ /// </summary>
+ public override string ToShortString()
{
return string.Format(CultureInfo.InvariantCulture,
"{0}: TaskName={1}, TaskClassName={2}, TaskSessionId={3}, JobId={4}, TaskNode={5}, " +
http://git-wip-us.apache.org/repos/asf/ignite/blob/9c785316/modules/platforms/dotnet/Apache.Ignite.Core/Events/TaskEvent.cs
----------------------------------------------------------------------
diff --git a/modules/platforms/dotnet/Apache.Ignite.Core/Events/TaskEvent.cs b/modules/platforms/dotnet/Apache.Ignite.Core/Events/TaskEvent.cs
index e2b9eaf..e7509b9 100644
--- a/modules/platforms/dotnet/Apache.Ignite.Core/Events/TaskEvent.cs
+++ b/modules/platforms/dotnet/Apache.Ignite.Core/Events/TaskEvent.cs
@@ -82,7 +82,9 @@ namespace Apache.Ignite.Core.Events
/// </summary>
public Guid? SubjectId { get { return _subjectId; } }
- /** <inheritDoc /> */
+ /// <summary>
+ /// Gets shortened version of ToString result.
+ /// </summary>
public override string ToShortString()
{
return string.Format(CultureInfo.InvariantCulture,
http://git-wip-us.apache.org/repos/asf/ignite/blob/9c785316/modules/platforms/dotnet/Apache.Ignite.Core/Impl/Cache/CacheEntry.cs
----------------------------------------------------------------------
diff --git a/modules/platforms/dotnet/Apache.Ignite.Core/Impl/Cache/CacheEntry.cs b/modules/platforms/dotnet/Apache.Ignite.Core/Impl/Cache/CacheEntry.cs
index 31bb2ed..136a49b 100644
--- a/modules/platforms/dotnet/Apache.Ignite.Core/Impl/Cache/CacheEntry.cs
+++ b/modules/platforms/dotnet/Apache.Ignite.Core/Impl/Cache/CacheEntry.cs
@@ -17,6 +17,7 @@
namespace Apache.Ignite.Core.Impl.Cache
{
+ using System;
using System.Collections.Generic;
using System.Globalization;
using Apache.Ignite.Core.Cache;
@@ -24,7 +25,7 @@ namespace Apache.Ignite.Core.Impl.Cache
/// <summary>
/// Represents a cache entry.
/// </summary>
- public struct CacheEntry<TK, TV> : ICacheEntry<TK, TV>
+ public struct CacheEntry<TK, TV> : ICacheEntry<TK, TV>, IEquatable<CacheEntry<TK, TV>>
{
/** Key. */
private readonly TK _key;
@@ -72,8 +73,15 @@ namespace Apache.Ignite.Core.Impl.Cache
return EqualityComparer<TK>.Default.Equals(_key, other._key) &&
EqualityComparer<TV>.Default.Equals(_val, other._val);
}
-
- /** <inheritDoc /> */
+
+ /// <summary>
+ /// Determines whether the specified <see cref="object" /> is equal to this instance.
+ /// </summary>
+ /// <param name="obj">The <see cref="object" /> to compare with this instance.</param>
+ /// <returns>
+ /// <c>true</c> if the specified <see cref="object" /> is equal to this instance;
+ /// otherwise, <c>false</c>.
+ /// </returns>
public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj))
@@ -81,8 +89,14 @@ namespace Apache.Ignite.Core.Impl.Cache
return obj is CacheEntry<TK, TV> && Equals((CacheEntry<TK, TV>) obj);
}
-
- /** <inheritDoc /> */
+
+ /// <summary>
+ /// Returns a hash code for this instance.
+ /// </summary>
+ /// <returns>
+ /// A hash code for this instance, suitable for use in hashing algorithms
+ /// and data structures like a hash table.
+ /// </returns>
public override int GetHashCode()
{
unchecked
@@ -92,7 +106,12 @@ namespace Apache.Ignite.Core.Impl.Cache
}
}
- /** <inheritDoc /> */
+ /// <summary>
+ /// Returns a <see cref="string" /> that represents this instance.
+ /// </summary>
+ /// <returns>
+ /// A <see cref="string" /> that represents this instance.
+ /// </returns>
public override string ToString()
{
return string.Format(CultureInfo.CurrentCulture, "CacheEntry [Key={0}, Value={1}]", _key, _val);
http://git-wip-us.apache.org/repos/asf/ignite/blob/9c785316/modules/platforms/dotnet/Apache.Ignite.Core/Services/ServiceInvocationException.cs
----------------------------------------------------------------------
diff --git a/modules/platforms/dotnet/Apache.Ignite.Core/Services/ServiceInvocationException.cs b/modules/platforms/dotnet/Apache.Ignite.Core/Services/ServiceInvocationException.cs
index cb0e2ae..b5dbf70 100644
--- a/modules/platforms/dotnet/Apache.Ignite.Core/Services/ServiceInvocationException.cs
+++ b/modules/platforms/dotnet/Apache.Ignite.Core/Services/ServiceInvocationException.cs
@@ -91,7 +91,14 @@ namespace Apache.Ignite.Core.Services
get { return _binaryCause; }
}
- /** <inheritdoc /> */
+ /// <summary>
+ /// When overridden in a derived class, sets the <see cref="SerializationInfo" />
+ /// with information about the exception.
+ /// </summary>
+ /// <param name="info">The <see cref="SerializationInfo" /> that holds the serialized object data
+ /// about the exception being thrown.</param>
+ /// <param name="context">The <see cref="StreamingContext" /> that contains contextual information
+ /// about the source or destination.</param>
[SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods")]
public override void GetObjectData(SerializationInfo info, StreamingContext context)
{