Tweaks xml doc comment formatting to match existing code.
Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/cbc2b689 Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/cbc2b689 Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/cbc2b689 Branch: refs/heads/TINKERPOP-1913 Commit: cbc2b68959842a3a01b9f776ed42486d3a135684 Parents: c720dba Author: Patrik Husfloen <[email protected]> Authored: Thu Sep 13 23:39:19 2018 +0200 Committer: Stephen Mallette <[email protected]> Committed: Tue Sep 18 12:58:42 2018 -0400 ---------------------------------------------------------------------- .../Driver/Exceptions/ResponseException.cs | 6 ++-- .../Driver/Messages/ResponseStatusCode.cs | 34 +++++++++++++------- .../src/Gremlin.Net/Driver/ResultSet.cs | 17 ++++------ 3 files changed, 32 insertions(+), 25 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/cbc2b689/gremlin-dotnet/src/Gremlin.Net/Driver/Exceptions/ResponseException.cs ---------------------------------------------------------------------- diff --git a/gremlin-dotnet/src/Gremlin.Net/Driver/Exceptions/ResponseException.cs b/gremlin-dotnet/src/Gremlin.Net/Driver/Exceptions/ResponseException.cs index f9020d2..59ac1aa 100644 --- a/gremlin-dotnet/src/Gremlin.Net/Driver/Exceptions/ResponseException.cs +++ b/gremlin-dotnet/src/Gremlin.Net/Driver/Exceptions/ResponseException.cs @@ -42,17 +42,17 @@ namespace Gremlin.Net.Driver.Exceptions IReadOnlyDictionary<string, object> statusAttributes, string message) : base(message) { - StatusAttributes = statusAttributes; StatusCode = statusCode; + StatusAttributes = statusAttributes; } /// <summary> - /// Gets the status code returned from the server. + /// Gets the status code returned from the server. /// </summary> public ResponseStatusCode StatusCode { get; } /// <summary> - /// Gets the status attributes from the gremlin response + /// Gets the status attributes from the gremlin response /// </summary> public IReadOnlyDictionary<string, object> StatusAttributes { get; } } http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/cbc2b689/gremlin-dotnet/src/Gremlin.Net/Driver/Messages/ResponseStatusCode.cs ---------------------------------------------------------------------- diff --git a/gremlin-dotnet/src/Gremlin.Net/Driver/Messages/ResponseStatusCode.cs b/gremlin-dotnet/src/Gremlin.Net/Driver/Messages/ResponseStatusCode.cs index 1c5d088..78f8759 100644 --- a/gremlin-dotnet/src/Gremlin.Net/Driver/Messages/ResponseStatusCode.cs +++ b/gremlin-dotnet/src/Gremlin.Net/Driver/Messages/ResponseStatusCode.cs @@ -26,62 +26,72 @@ using System; namespace Gremlin.Net.Driver.Messages { /// <summary> - /// Represents the various status codes that Gremlin Server returns. + /// Represents the various status codes that Gremlin Server returns. /// </summary> public enum ResponseStatusCode { /// <summary> - /// The server successfully processed a request to completion - there are no messages remaining in this stream. + /// The server successfully processed a request to completion - there are no messages remaining in this + /// stream. /// </summary> Success = 200, /// <summary> - /// The server processed the request but there is no result to return (e.g. an Iterator with no elements) - there are no messages remaining in this stream. + /// The server processed the request but there is no result to return (e.g. an Iterator with no elements) + /// - there are no messages remaining in this stream. /// </summary> NoContent = 204, /// <summary> - /// The server successfully returned some content, but there is more in the stream to arrive - wait for a SUCCESS to signify the end of the stream. + /// The server successfully returned some content, but there is more in the stream to arrive - wait for a + /// SUCCESS to signify the end of the stream. /// </summary> PartialContent = 206, /// <summary> - /// The request attempted to access resources that the requesting user did not have access to. + /// The request attempted to access resources that the requesting user did not have access to. /// </summary> Unauthorized = 401, /// <summary> - /// A challenge from the server for the client to authenticate its request. + /// A challenge from the server for the client to authenticate its request. /// </summary> Authenticate = 407, /// <summary> - /// The request message was not properly formatted which means it could not be parsed at all or the "op" code was not recognized such that Gremlin Server could properly route it for processing. Check the message format and retry the request. + /// The request message was not properly formatted which means it could not be parsed at all or the "op" code + /// was not recognized such that Gremlin Server could properly route it for processing. Check the message format + /// and retry the request. /// </summary> MalformedRequest = 498, /// <summary> - /// The request message was parseable, but the arguments supplied in the message were in conflict or incomplete. Check the message format and retry the request. + /// The request message was parseable, but the arguments supplied in the message were in conflict or incomplete. + /// Check the message format and retry the request. /// </summary> InvalidRequestArguments = 499, /// <summary> - /// A general server error occurred that prevented the request from being processed. + /// A general server error occurred that prevented the request from being processed. /// </summary> ServerError = 500, /// <summary> - /// The script submitted for processing evaluated in the ScriptEngine with errors and could not be processed. Check the script submitted for syntax errors or other problems and then resubmit. + /// The script submitted for processing evaluated in the ScriptEngine with errors and could not be processed. + /// Check the script submitted for syntax errors or other problems and then resubmit. /// </summary> ScriptEvaluationError = 597, /// <summary> - /// The server exceeded one of the timeout settings for the request and could therefore only partially responded or did not respond at all. + /// The server exceeded one of the timeout settings for the request and could therefore only partially responded + /// or did not respond at all. /// </summary> ServerTimeout = 598, /// <summary> - /// The server was not capable of serializing an object that was returned from the script supplied on the request. Either transform the object into something Gremlin Server can process within the script or install mapper serialization classes to Gremlin Server. + /// The server was not capable of serializing an object that was returned from the script supplied on the request. + /// Either transform the object into something Gremlin Server can process within the script or install mapper + /// serialization classes to Gremlin Server. /// </summary> ServerSerializationError = 599 } http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/cbc2b689/gremlin-dotnet/src/Gremlin.Net/Driver/ResultSet.cs ---------------------------------------------------------------------- diff --git a/gremlin-dotnet/src/Gremlin.Net/Driver/ResultSet.cs b/gremlin-dotnet/src/Gremlin.Net/Driver/ResultSet.cs index 00a24d3..62a0b3c 100644 --- a/gremlin-dotnet/src/Gremlin.Net/Driver/ResultSet.cs +++ b/gremlin-dotnet/src/Gremlin.Net/Driver/ResultSet.cs @@ -27,8 +27,8 @@ using System.Collections.Generic; namespace Gremlin.Net.Driver { /// <summary> - /// A ResultSet is returned from the submission of a Gremlin script to the server and represents the results provided by the server - /// ResultSet includes enumerable data and status attributes. + /// A ResultSet is returned from the submission of a Gremlin script to the server and represents the results + /// provided by the server. ResultSet includes enumerable data and status attributes. /// </summary> /// <typeparam name="T">Type of the result elements</typeparam> public sealed class ResultSet<T> : IReadOnlyCollection<T> @@ -36,12 +36,12 @@ namespace Gremlin.Net.Driver private readonly IReadOnlyCollection<T> _data; /// <summary> - /// Gets or sets the status attributes from the gremlin response + /// Gets or sets the status attributes from the gremlin response /// </summary> public IReadOnlyDictionary<string, object> StatusAttributes { get; } /// <summary> - /// Initializes a new instance of the ResultSet class for the specified data and status attributes. + /// Initializes a new instance of the ResultSet class for the specified data and status attributes. /// </summary> /// <param name="data"></param> /// <param name="attributes"></param> @@ -51,22 +51,19 @@ namespace Gremlin.Net.Driver this.StatusAttributes = attributes; } - /// <summary>Returns an enumerator that iterates through the collection.</summary> - /// <returns>An enumerator that can be used to iterate through the collection.</returns> + /// <inheritdoc cref="IReadOnlyCollection{T}"/> public IEnumerator<T> GetEnumerator() { return _data.GetEnumerator(); } - /// <summary>Returns an enumerator that iterates through a collection.</summary> - /// <returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns> + /// <inheritdoc cref="IReadOnlyCollection{T}"/> IEnumerator IEnumerable.GetEnumerator() { return _data.GetEnumerator(); } - /// <summary>Gets the number of elements in the collection.</summary> - /// <returns>The number of elements in the collection. </returns> + /// <inheritdoc cref="IReadOnlyCollection{T}"/> public int Count => _data.Count; } }
