Skip to content

Commit 74a8c5b

Browse files
fredericDelaportefredericDelaporte
committed
Generate XML comment documentation
1 parent 3daa4c7 commit 74a8c5b

File tree

57 files changed

+507
-344
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+507
-344
lines changed

‎CoreMemoryCache/NHibernate.Caches.CoreMemoryCache/CoreMemoryCacheProvider.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
namespace NHibernate.Caches.CoreMemoryCache
3131
{
3232
/// <summary>
33-
/// Cache provider using the System.Runtime.Caching classes
33+
/// Cache provider using the Microsoft.Extensions.Caching.Memory classes.
3434
/// </summary>
3535
public class CoreMemoryCacheProvider : ICacheProvider
3636
{

‎CoreMemoryCache/NHibernate.Caches.CoreMemoryCache/CoreMemoryCacheSectionHandler.cs‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,8 @@ public class CoreMemoryCacheSectionHandler : IConfigurationSectionHandler
1313

1414
#region IConfigurationSectionHandler Members
1515

16-
/// <summary>
17-
/// Parse the config section.
18-
/// </summary>
19-
/// <param name="parent"></param>
20-
/// <param name="configContext"></param>
21-
/// <param name="section"></param>
22-
/// <returns>A <see cref="CacheConfig" /> object.</returns>
16+
/// <inheritdoc />
17+
/// <returns>A <see cref="T:NHibernate.Caches.CoreMemoryCache.CacheConfig" /> object.</returns>
2318
public object Create(object parent, object configContext, XmlNode section)
2419
{
2520
var caches = new List<RegionConfig>();

‎CoreMemoryCache/NHibernate.Caches.CoreMemoryCache/NHibernate.Caches.CoreMemoryCache.csproj‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
<TargetFrameworks>net461;netstandard2.0</TargetFrameworks>
1010
<SignAssembly>True</SignAssembly>
1111
<AssemblyOriginatorKeyFile>..\..\NHibernate.Caches.snk</AssemblyOriginatorKeyFile>
12+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
1213
<PackageReleaseNotes>* New feature
1314
* #25 - Add a .Net Core MemoryCache</PackageReleaseNotes>
1415
</PropertyGroup>

‎EnyimMemcached/NHibernate.Caches.EnyimMemcached/Async/MemCacheClient.cs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ public partial class MemCacheClient : ICache
2727

2828
#region ICache Members
2929

30+
/// <inheritdoc />
3031
public Task<object> GetAsync(object key, CancellationToken cancellationToken)
3132
{
3233
if (cancellationToken.IsCancellationRequested)
@@ -43,6 +44,7 @@ public Task<object> GetAsync(object key, CancellationToken cancellationToken)
4344
}
4445
}
4546

47+
/// <inheritdoc />
4648
public Task PutAsync(object key, object value, CancellationToken cancellationToken)
4749
{
4850
if (key == null)
@@ -68,6 +70,7 @@ public Task PutAsync(object key, object value, CancellationToken cancellationTok
6870
}
6971
}
7072

73+
/// <inheritdoc />
7174
public Task RemoveAsync(object key, CancellationToken cancellationToken)
7275
{
7376
if (key == null)
@@ -89,6 +92,7 @@ public Task RemoveAsync(object key, CancellationToken cancellationToken)
8992
}
9093
}
9194

95+
/// <inheritdoc />
9296
public Task ClearAsync(CancellationToken cancellationToken)
9397
{
9498
if (cancellationToken.IsCancellationRequested)
@@ -106,6 +110,7 @@ public Task ClearAsync(CancellationToken cancellationToken)
106110
}
107111
}
108112

113+
/// <inheritdoc />
109114
public Task LockAsync(object key, CancellationToken cancellationToken)
110115
{
111116
if (cancellationToken.IsCancellationRequested)
@@ -123,6 +128,7 @@ public Task LockAsync(object key, CancellationToken cancellationToken)
123128
}
124129
}
125130

131+
/// <inheritdoc />
126132
public Task UnlockAsync(object key, CancellationToken cancellationToken)
127133
{
128134
if (cancellationToken.IsCancellationRequested)

‎EnyimMemcached/NHibernate.Caches.EnyimMemcached/MemCacheClient.cs‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010

1111
namespace NHibernate.Caches.EnyimMemcached
1212
{
13+
/// <summary>
14+
/// Pluggable cache implementation using Memcached and the EnyimMemcached client library.
15+
/// </summary>
1316
public partial class MemCacheClient : ICache
1417
{
1518
private static readonly IInternalLogger log;
@@ -27,21 +30,39 @@ static MemCacheClient()
2730
log = LoggerProvider.LoggerFor(typeof (MemCacheClient));
2831
}
2932

33+
/// <summary>
34+
/// Default constructor.
35+
/// </summary>
3036
public MemCacheClient()
3137
: this("nhibernate", null)
3238
{
3339
}
3440

41+
/// <summary>
42+
/// Contructor with no properties.
43+
/// </summary>
44+
/// <param name="regionName">The cache region name.</param>
3545
public MemCacheClient(string regionName)
3646
: this(regionName, null)
3747
{
3848
}
3949

50+
/// <summary>
51+
/// Constructor with default Memcache client instance.
52+
/// </summary>
53+
/// <param name="regionName">The cache region name.</param>
54+
/// <param name="properties">The configuration properties.</param>
4055
public MemCacheClient(string regionName, IDictionary<string, string> properties)
4156
: this(regionName, properties, new MemcachedClient())
4257
{
4358
}
4459

60+
/// <summary>
61+
/// Full constructor.
62+
/// </summary>
63+
/// <param name="regionName">The cache region name.</param>
64+
/// <param name="properties">The configuration properties.</param>
65+
/// <param name="memcachedClient">The Memcache client.</param>
4566
[CLSCompliant(false)]
4667
public MemCacheClient(string regionName, IDictionary<string, string> properties, MemcachedClient memcachedClient)
4768
{
@@ -107,6 +128,7 @@ private static MD5 Md5
107128

108129
#region ICache Members
109130

131+
/// <inheritdoc />
110132
public object Get(object key)
111133
{
112134
if (key == null)
@@ -134,6 +156,7 @@ public object Get(object key)
134156
return null;
135157
}
136158

159+
/// <inheritdoc />
137160
public void Put(object key, object value)
138161
{
139162
if (key == null)
@@ -162,6 +185,7 @@ public void Put(object key, object value)
162185
}
163186
}
164187

188+
/// <inheritdoc />
165189
public void Remove(object key)
166190
{
167191
if (key == null)
@@ -175,36 +199,43 @@ public void Remove(object key)
175199
client.Remove(KeyAsString(key));
176200
}
177201

202+
/// <inheritdoc />
178203
public void Clear()
179204
{
180205
client.FlushAll();
181206
}
182207

208+
/// <inheritdoc />
183209
public void Destroy()
184210
{
185211
Clear();
186212
}
187213

214+
/// <inheritdoc />
188215
public void Lock(object key)
189216
{
190217
// do nothing
191218
}
192219

220+
/// <inheritdoc />
193221
public void Unlock(object key)
194222
{
195223
// do nothing
196224
}
197225

226+
/// <inheritdoc />
198227
public long NextTimestamp()
199228
{
200229
return Timestamper.Next();
201230
}
202231

232+
/// <inheritdoc />
203233
public int Timeout
204234
{
205235
get { return Timestamper.OneMs*60000; }
206236
}
207237

238+
/// <inheritdoc />
208239
public string RegionName
209240
{
210241
get { return region; }

‎EnyimMemcached/NHibernate.Caches.EnyimMemcached/MemCacheProvider.cs‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
namespace NHibernate.Caches.EnyimMemcached
1010
{
1111
/// <summary>
12-
/// Cache provider using the .NET client (http://github.com/enyim/EnyimMemcached)
13-
/// for memcached, which is located at http://memcached.org/
12+
/// Cache provider using the .NET client EnyimMemcached (http://github.com/enyim/EnyimMemcached)
13+
/// for memcached, which is located at http://memcached.org/.
1414
/// </summary>
1515
public class MemCacheProvider : ICacheProvider
1616
{
@@ -34,6 +34,7 @@ static MemCacheProvider()
3434

3535
#region ICacheProvider Members
3636

37+
/// <inheritdoc />
3738
public ICache BuildCache(string regionName, IDictionary<string, string> properties)
3839
{
3940
if (regionName == null)
@@ -60,11 +61,13 @@ public ICache BuildCache(string regionName, IDictionary<string, string> properti
6061
return new MemCacheClient(regionName, properties, clientInstance);
6162
}
6263

64+
/// <inheritdoc />
6365
public long NextTimestamp()
6466
{
6567
return Timestamper.Next();
6668
}
6769

70+
/// <inheritdoc />
6871
public void Start(IDictionary<string, string> properties)
6972
{
7073
// Needs to lock staticly because the pool and the internal maintenance thread
@@ -83,6 +86,7 @@ public void Start(IDictionary<string, string> properties)
8386
}
8487
}
8588

89+
/// <inheritdoc />
8690
public void Stop()
8791
{
8892
lock (syncObject)

‎EnyimMemcached/NHibernate.Caches.EnyimMemcached/NHibernate.Caches.EnyimMemcached.csproj‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
<TargetFramework>net461</TargetFramework>
88
<SignAssembly>True</SignAssembly>
99
<AssemblyOriginatorKeyFile>..\..\NHibernate.Caches.snk</AssemblyOriginatorKeyFile>
10+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
1011
<PackageReleaseNotes>* Improvement
1112
* #24 - Generates ICache async counter-parts instead of hand coding them</PackageReleaseNotes>
1213
</PropertyGroup>

‎MemCache/NHibernate.Caches.MemCache/Async/MemCacheClient.cs‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,19 @@
1313
using System.Collections.Generic;
1414
using System.Security.Cryptography;
1515
using System.Text;
16-
using System.Threading;
17-
using System.Threading.Tasks;
1816
using Memcached.ClientLibrary;
1917
using NHibernate.Cache;
2018

2119
namespace NHibernate.Caches.MemCache
2220
{
21+
using System.Threading.Tasks;
22+
using System.Threading;
2323
public partial class MemCacheClient : ICache
2424
{
2525

2626
#region ICache Members
2727

28+
/// <inheritdoc />
2829
public Task<object> GetAsync(object key, CancellationToken cancellationToken)
2930
{
3031
if (cancellationToken.IsCancellationRequested)
@@ -41,6 +42,7 @@ public Task<object> GetAsync(object key, CancellationToken cancellationToken)
4142
}
4243
}
4344

45+
/// <inheritdoc />
4446
public Task PutAsync(object key, object value, CancellationToken cancellationToken)
4547
{
4648
if (key == null)
@@ -66,6 +68,7 @@ public Task PutAsync(object key, object value, CancellationToken cancellationTok
6668
}
6769
}
6870

71+
/// <inheritdoc />
6972
public Task RemoveAsync(object key, CancellationToken cancellationToken)
7073
{
7174
if (key == null)
@@ -87,6 +90,7 @@ public Task RemoveAsync(object key, CancellationToken cancellationToken)
8790
}
8891
}
8992

93+
/// <inheritdoc />
9094
public Task ClearAsync(CancellationToken cancellationToken)
9195
{
9296
if (cancellationToken.IsCancellationRequested)
@@ -104,6 +108,7 @@ public Task ClearAsync(CancellationToken cancellationToken)
104108
}
105109
}
106110

111+
/// <inheritdoc />
107112
public Task LockAsync(object key, CancellationToken cancellationToken)
108113
{
109114
if (cancellationToken.IsCancellationRequested)
@@ -121,6 +126,7 @@ public Task LockAsync(object key, CancellationToken cancellationToken)
121126
}
122127
}
123128

129+
/// <inheritdoc />
124130
public Task UnlockAsync(object key, CancellationToken cancellationToken)
125131
{
126132
if (cancellationToken.IsCancellationRequested)

0 commit comments

Comments
 (0)