Skip to content

Commit

Permalink
GEODE-6546: Fix doc comments for IRegion (#493)
Browse files Browse the repository at this point in the history
- Also remove unnecessary parameter to IRegion::Put call in PutGetRemove
.net example
  • Loading branch information
Blake Bender committed Jun 6, 2019
1 parent e309b57 commit b3ed871
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 23 deletions.
40 changes: 19 additions & 21 deletions clicache/src/IRegion.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ namespace Apache
/// This property is applicable to local as well as distributed region.
/// For local region instance - Puts/Gets a new value into an entry in this region in the local cache only.
/// For distributed region instance - Puts/Gets a new value into an entry in this region
/// and this operation is propogated to the Geode cache server to which it is connected with.
/// and this operation is propogated to the Geode cache server to which it is connected.
/// </remarks>
/// <param name="key">
/// The key of the element to get or set.
Expand Down Expand Up @@ -487,7 +487,7 @@ namespace Apache
/// <para>
/// For local region instance - removes the value with the specified key in the local cache only.
/// For distributed region instance - destroy is propogated to the Geode cache server
/// to which it is connected with.
/// to which it is connected.
/// </para>
/// <para>
/// Does not update any <c>CacheStatistics</c>.
Expand Down Expand Up @@ -679,7 +679,7 @@ namespace Apache
/// from this region.
/// </para>
/// <para>
/// The Remove is propogated to the Geode cache server to which it is connected with.
/// The Remove is propogated to the Geode cache server to which it is connected.
/// </para>
/// <para>
/// Does not update any <c>CacheStatistics</c>.
Expand Down Expand Up @@ -727,7 +727,7 @@ namespace Apache
/// from this region.
/// </para>
/// <para>
/// The Remove is propogated to the Geode cache server to which it is connected with.
/// The Remove is propogated to the Geode cache server to which it is connected.
/// </para>
/// <para>
/// Does not update any <c>CacheStatistics</c>.
Expand Down Expand Up @@ -845,13 +845,13 @@ namespace Apache
/// <para>
/// If there is already an entry associated with the specified key in
/// this region, the entry's previous value is overwritten.
/// The new put value is propogated to the java server to which it is connected with.
/// The new put value is propogated to the java server to which it is connected.
/// Put is intended for very simple caching situations. In general
/// it is better to create a <c>ICacheLoader</c> object and allow the
/// cache to manage the creation and loading of objects.
/// For local region instance - Puts a new value into an entry in this region in the local cache only.
/// For distributed region instance - Puts a new value into an entry in this region
/// and this operation is propogated to the Geode cache server to which it is connected with.
/// and this operation is propogated to the Geode cache server to which it is connected.
/// </para><para>
/// Updates the <see cref="CacheStatistics.LastAccessedTime" /> and
/// <see cref="CacheStatistics.LastModifiedTime" /> for this region and the entry.
Expand Down Expand Up @@ -903,21 +903,19 @@ namespace Apache
void Put(TKey key, TValue value, Object^ callbackArg);

/// <summary>
/// Puts a new value into an entry in this region with the specified key,
/// passing the callback argument to any cache writers and cache listeners
/// that are invoked in the operation.
/// Puts a new value into an entry in this region with the specified key.
/// </summary>
/// <remarks>
/// <para>
/// If there is already an entry associated with the specified key in
/// this region, the entry's previous value is overwritten.
/// The new put value is propogated to the java server to which it is connected with.
/// The new put value is propogated to the java server to which it is connected.
/// Put is intended for very simple caching situations. In general
/// it is better to create a <c>ICacheLoader</c> object and allow the
/// cache to manage the creation and loading of objects.
/// For local region instance - Puts a new value into an entry in this region in the local cache only.
/// For distributed region instance - Puts a new value into an entry in this region
/// and this operation is propogated to the Geode cache server to which it is connected with.
/// and this operation is propogated to the Geode cache server to which it is connected.
/// </para><para>
/// Updates the <see cref="CacheStatistics.LastAccessedTime" /> and
/// <see cref="CacheStatistics.LastModifiedTime" /> for this region and the entry.
Expand All @@ -930,7 +928,7 @@ namespace Apache
/// </para>
/// </remarks>
/// <param name="key">
/// a key object associated with the value to be put into this region.
/// a key object associated with the value to be put into this region
/// </param>
/// <param name="value">the value to be put into this region</param>
/// <exception cref="IllegalArgumentException">
Expand Down Expand Up @@ -1096,7 +1094,7 @@ namespace Apache
/// and the entries in it will still exist.
/// For local region instance - invalidates this region without distributing to other caches.
/// For distributed region instance - Invalidates this region and this
/// operation is propogated to the Geode cache server to which it is connected with.
/// operation is propogated to the Geode cache server to which it is connected.
/// </para>
/// <para>
/// To remove all the
Expand Down Expand Up @@ -1132,7 +1130,7 @@ namespace Apache
/// and the entries in it will still exist.
/// For local region instance - invalidates this region without distributing to other caches.
/// For distributed region instance - Invalidates this region and this
/// operation is propogated to the Geode cache server to which it is connected with.
/// operation is propogated to the Geode cache server to which it is connected.
/// </para>
/// <para>
/// To remove all the
Expand Down Expand Up @@ -1174,7 +1172,7 @@ namespace Apache
/// server region.
/// For local region instance - destroys the whole local region only
/// For distributed region instance - destroys the whole local region and this
/// operation is also propogated to the Geode cache server to which it is connected with.
/// operation is also propogated to the Geode cache server to which it is connected.
/// </para><para>
/// Does not update any <c>CacheStatistics</c>.
/// </para>
Expand Down Expand Up @@ -1216,7 +1214,7 @@ namespace Apache
/// server region.
/// For local region instance - destroys the whole local region only
/// For distributed region instance - destroys the whole local region and this
/// operation is also propogated to the Geode cache server to which it is connected with.
/// operation is also propogated to the Geode cache server to which it is connected.
/// </para><para>
/// Does not update any <c>CacheStatistics</c>.
/// </para>
Expand Down Expand Up @@ -1261,7 +1259,7 @@ namespace Apache
/// </para>
/// <para>
/// For both local & distributed region instaces, invalidate is not propogated to the
/// Geode cache server to which it is connected with.
/// Geode cache server to which it is connected.
/// </para>
/// <para>
/// Does not update any <c>CacheStatistics</c>.
Expand Down Expand Up @@ -1292,7 +1290,7 @@ namespace Apache
/// </para>
/// <para>
/// For both local & distributed region instaces, invalidate is not propogated to the
/// Geode cache server to which it is connected with.
/// Geode cache server to which it is connected.
/// </para>
/// <para>
/// Does not update any <c>CacheStatistics</c>.
Expand Down Expand Up @@ -1320,7 +1318,7 @@ namespace Apache
/// <para>
/// If there is already an entry associated with any key in the map in
/// this region, the entry's previous value is overwritten.
/// The new values are propogated to the java server to which it is connected with.
/// The new values are propogated to the java server to which it is connected.
/// PutAll is intended for speed up large amount of put operation into
/// the same region.
/// For local region instance - this method is not applicable.
Expand Down Expand Up @@ -1365,7 +1363,7 @@ namespace Apache
/// <para>
/// If there is already an entry associated with any key in the map in
/// this region, the entry's previous value is overwritten.
/// The new values are propogated to the java server to which it is connected with.
/// The new values are propogated to the java server to which it is connected.
/// PutAll is intended for speed up large amount of put operation into
/// the same region.
/// For local region instance - this method is not applicable.
Expand Down Expand Up @@ -1417,7 +1415,7 @@ namespace Apache
/// <para>
/// If there is already an entry associated with any key in the map in
/// this region, the entry's previous value is overwritten.
/// The new values are propogated to the java server to which it is connected with.
/// The new values are propogated to the java server to which it is connected.
/// PutAll is intended for speed up large amount of put operation into
/// the same region.
/// For local region instance - this method is not applicable.
Expand Down
4 changes: 2 additions & 2 deletions examples/dotnet/putgetremove/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ static void Main(string[] args)
const string scharlesKey = "scharles";
const string scharlesValue = "Sylvia Charles";

region.Put(rtimmonsKey, rtimmonsValue, null);
region.Put(scharlesKey, scharlesValue, null);
region.Put(rtimmonsKey, rtimmonsValue);
region.Put(scharlesKey, scharlesValue);

Console.WriteLine("Getting the user info from the region");
var user1 = region.Get(rtimmonsKey, null);
Expand Down

0 comments on commit b3ed871

Please sign in to comment.