API doc improvement #152
API doc improvement #152
Conversation
|
Linux Net Core Tests PASSed. |
|
Test FAILed. |
|
Windows .Net Framework Tests PASSed. |
| /// <returns>The message type field value.</returns> | ||
| int GetMessageType(); | ||
|
|
||
| /// <summary>Returns the correlation id field.</summary> |
There was a problem hiding this comment.
As far as I see, usually, ID is used in the code comments, instead of id. There are couple "id"s in the following lines.
| { | ||
| /// <summary> | ||
| /// Marker interface for exceptions to indicate that an operation can be retried. | ||
| /// E.g. a map.get send to a machine where the partition has just moved to another machine. |
There was a problem hiding this comment.
/// E.g., a map.get sent to a machine....
| } | ||
|
|
||
| /// <summary> | ||
| /// A <see cref="RetryableHazelcastException"/> that indicates operation is send to a machine that isn't member of the cluster |
There was a problem hiding this comment.
...operation is sent to a machine that isn't member of the cluster.
|
Windows Net Core Tests PASSed. |
|
|
||
| /// <summary> | ||
| /// Thrown when a client invocation is failed because related target is disconnected and | ||
| /// whether the invocation is run or not, is indeterminate |
There was a problem hiding this comment.
...failed because the related target is disconnected, and whether the invocation runs or not is indeterminate.
| /// Client service to add/remove remote listeners. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// For smart client, it registers local listeners to all nodes in cluster. |
| /// Partition service for Hazelcast clients. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// Allows to retrieve information about the partition count, the partition owner or the partitionId of a key. |
There was a problem hiding this comment.
...about the partition count, partition owner or partitionId of a key.
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets configured <see cref="ILoadBalancer"/> instance |
There was a problem hiding this comment.
/// Gets the configured ... instance.
| namespace Hazelcast.Config | ||
| { | ||
| /// <summary> | ||
| /// Main configuration to setup a Hazelcast Client |
| private SerializationConfig _serializationConfig = new SerializationConfig(); | ||
|
|
||
| /// <summary> | ||
| /// Helper method to add a new ListenerConfig |
There was a problem hiding this comment.
I guess it is best to use periods at the end of sentences that are in-between the "summary" tags. There are a couple of lines in the following comments.
| } | ||
|
|
||
| /// <summary> | ||
| /// pool-size for internal ExecutorService which handles responses etc. |
There was a problem hiding this comment.
/// Gets pool-size ... handles responses, etc.
| } | ||
|
|
||
| /// <summary> | ||
| /// Map of all configured NearCacheConfig's with the name key and configuration as the value |
There was a problem hiding this comment.
...configured Near Cache configs with...
| } | ||
|
|
||
| /// <summary> | ||
| /// sets pool-size for internal ExecutorService which handles responses etc. |
There was a problem hiding this comment.
/// Sets pool-size ... handles responses, etc.
| } | ||
|
|
||
| /// <summary> | ||
| /// Sets all near cache configs |
There was a problem hiding this comment.
/// Sets all Near Cache configs.
| namespace Hazelcast.Config | ||
| { | ||
| /// <summary> | ||
| /// Contains configuration parameters for client network related behaviour |
| private SSLConfig _sslConfig = new SSLConfig(); | ||
|
|
||
| /// <summary> | ||
| /// Adds given addresses to candidate address list that client will use to establish initial connection |
There was a problem hiding this comment.
...addresses to the list of candidate addresses ... connection. (standardizing the expression of this list).
| } | ||
|
|
||
| /// <summary> | ||
| /// Returns connection attempt period in millis, Period for the next attempt to find a member to connect. |
There was a problem hiding this comment.
/// Returns the connection attempt period, in millis, for the next attempt to find a member to connect.
| } | ||
|
|
||
| /// <summary> | ||
| /// is redo operations are enabled or not |
There was a problem hiding this comment.
/// Specifies whether the redo operations are enabled or not.
| /// <summary> | ||
| /// While client is trying to connect initially to one of the members in the configured address list, | ||
| /// all might be not available. Instead of giving up, throwing Exception and stopping client, it will | ||
| /// attempt to retry as much as connection Attempt Limit times. |
There was a problem hiding this comment.
...connection attempt limit times.
| /// <summary> | ||
| /// While client is trying to connect initially to one of the members in the configured address list, | ||
| /// all might be not available. Instead of giving up, throwing Exception and stopping client, it will | ||
| /// attempt to retry as much as connection Attempt Limit times. |
There was a problem hiding this comment.
...connection attempt limit times.
| } | ||
|
|
||
| /// <summary> | ||
| /// Sets connection attempt period in millis, Period for the next attempt to find a member to connect. |
There was a problem hiding this comment.
/// Sets the connection attempt period, in millis, for the next attempt to find a member to connect.
| /// <summary> | ||
| /// If true, client will redo the operations that were executing on the server and client lost the connection. | ||
| /// This can be because of network, or simply because the member died. However it is not clear whether the | ||
| /// application is performed or not.For idempotent operations this is harmless, but for non idempotent ones |
There was a problem hiding this comment.
...performed or not. For idempotent ..., but for non-idempotent ones ...
| /// If true, client will redo the operations that were executing on the server and client lost the connection. | ||
| /// This can be because of network, or simply because the member died. However it is not clear whether the | ||
| /// application is performed or not.For idempotent operations this is harmless, but for non idempotent ones | ||
| /// retrying can cause to undesirable effects.Note that the redo can perform on any member. |
| public sealed class GroupConfig | ||
| { | ||
| /// <summary> | ||
| /// default group password |
There was a problem hiding this comment.
/// Default group password. (capitalizing the first word; there are a couple of lines like this in the following code comments.)
| } | ||
|
|
||
| /// <summary> | ||
| /// Returns the maximum number of seconds each entry can stay in the Near Cache as untouched (not-read). |
|
|
||
| /// <summary> | ||
| /// Returns the maximum number of seconds each entry can stay in the Near Cache as untouched (not-read). | ||
| /// Entries that are not read (touched) more than <c>maxIdleSeconds</c> value will get removed from the Near Cache. |
There was a problem hiding this comment.
I think it should be like: /// Entries that are not read (untouched) more than...
Or just like this: /// Entries that are not read more than...
| /// Returns the maximum number of seconds each entry can stay in the Near Cache as untouched (not-read). | ||
| /// Entries that are not read (touched) more than <c>maxIdleSeconds</c> value will get removed from the Near Cache. | ||
| /// </summary> | ||
| /// <returns>maximum number of seconds each entry can stay in the Near Cache as untouched (not-read)</returns> |
| } | ||
|
|
||
| /// <summary> | ||
| /// Set the maximum number of seconds each entry can stay in the Near Cache as untouched (not-read). |
| /// <summary> | ||
| /// Set the maximum number of seconds each entry can stay in the Near Cache as untouched (not-read). | ||
| /// <br/> | ||
| /// Entries that are not read(touched) more than <c>maxIdleSeconds</c> value will get removed from the Near Cache. |
There was a problem hiding this comment.
I think it should be like: /// Entries that are not read (untouched) more than...
Or just like this: /// Entries that are not read more than...
| namespace Hazelcast.Config | ||
| { | ||
| /// <summary> | ||
| /// This class is related to SPI. To register custom services to client. |
There was a problem hiding this comment.
/// This class is related to SPI; it is used to register custom services to client.
| } | ||
|
|
||
| /// <summary> | ||
| /// Build a ClientConfig from an xml file |
| /// <summary> | ||
| /// Build a ClientConfig from an xml file | ||
| /// </summary> | ||
| /// <param name="configFile">hazelcast client xml config file</param> |
There was a problem hiding this comment.
///...>Hazelcast client XML config file<...
| /// <summary> | ||
| /// Build a ClientConfig from an xml file | ||
| /// </summary> | ||
| /// <param name="reader">Text reader to provide hazelcast client xml</param> |
There was a problem hiding this comment.
...Hazelcast client XML<...
| } | ||
|
|
||
| /// <summary> | ||
| /// Creates a client config using the xml content |
asimarslan
force-pushed
the
api-doc-improvement
branch
from
1233cb8 to
607cc64
Compare
|
Windows Net Core Tests PASSed. |
|
Linux Net Core Tests PASSed. |
asimarslan
force-pushed
the
api-doc-improvement
branch
2 times, most recently
from
2b7784f to
03e5aca
Compare
|
Windows .Net Framework Tests PASSed. |
|
Linux Net Core Tests PASSed. |
|
Windows Net Core Tests PASSed. |
|
Linux Net Core Tests PASSed. |
|
Windows .Net Framework Tests PASSed. |
Added Test Categories for features introduced at specific versions
asimarslan
force-pushed
the
api-doc-improvement
branch
from
03e5aca to
fd2e366
Compare
|
Windows Net Core Tests PASSed. |
|
Linux Net Core Tests PASSed. |
|
Windows .Net Framework Tests PASSed. |
No description provided.