Skip to content

Commit fbbe23b

Browse files
Documentation fixes.
1 parent 1abd70e commit fbbe23b

File tree

6 files changed

+14
-16
lines changed

6 files changed

+14
-16
lines changed

RtMemoryCache/NHibernate.Caches.RtMemoryCache/Async/RtMemoryCache.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313
using System.Runtime.Caching;
1414
using NHibernate.Cache;
1515
using System.Collections.Generic;
16-
using System.Threading;
17-
using System.Threading.Tasks;
1816
using NHibernate.Util;
1917

2018
namespace NHibernate.Caches.RtMemoryCache
2119
{
20+
using System.Threading.Tasks;
21+
using System.Threading;
2222
public partial class RtMemoryCache : ICache
2323
{
2424

RtMemoryCache/NHibernate.Caches.RtMemoryCache/NHibernate.Caches.RtMemoryCache.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<PropertyGroup>
44
<Product>NHibernate.Caches.RtMemoryCache</Product>
55
<Title>NHibernate.Caches.RtMemoryCache</Title>
6-
<Description>Cache provider for NHibernate using MemoryCache.</Description>
6+
<Description>Cache provider for NHibernate using MemoryCache (System.Runtime.Caching).</Description>
77
<TargetFramework>net461</TargetFramework>
88
<SignAssembly>True</SignAssembly>
99
<AssemblyOriginatorKeyFile>..\..\NHibernate.Caches.snk</AssemblyOriginatorKeyFile>

RtMemoryCache/NHibernate.Caches.RtMemoryCache/RtMemoryCache.cs

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@
2525
using System.Runtime.Caching;
2626
using NHibernate.Cache;
2727
using System.Collections.Generic;
28-
using System.Threading;
29-
using System.Threading.Tasks;
3028
using NHibernate.Util;
3129

3230
namespace NHibernate.Caches.RtMemoryCache
@@ -71,14 +69,14 @@ public RtMemoryCache(string region)
7169
/// <param name="region"></param>
7270
/// <param name="properties">cache configuration properties</param>
7371
/// <remarks>
74-
/// There are two (2) configurable parameters:
72+
/// There are three (3) configurable parameters:
7573
/// <ul>
76-
/// <li>expiration = number of seconds to wait before expiring each item</li>
77-
/// <li>priority = a numeric cost of expiring each item, where 1 is a low cost, 5 is the highest, and 3 is normal. Only values 1 through 5 are valid.</li>
74+
/// <li>expiration (or cache.default_expiration) = number of seconds to wait before expiring each item.</li>
75+
/// <li>cache.use_sliding_expiration = a boolean, true for resetting a cached item expiration each time it is accessed.</li>
76+
/// <li>regionPrefix = a string for prefixing the region name.</li>
7877
/// </ul>
79-
/// All parameters are optional. The defaults are an expiration of 300 seconds and the default priority of 3.
78+
/// All parameters are optional. The defaults are an expiration of 300 seconds, no sliding expiration, no region prefix.
8079
/// </remarks>
81-
/// <exception cref="IndexOutOfRangeException">The "priority" property is not between 1 and 5</exception>
8280
/// <exception cref="ArgumentException">The "expiration" property could not be parsed.</exception>
8381
public RtMemoryCache(string region, IDictionary<string, string> properties)
8482
{

RtMemoryCache/default.build

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<project
33
name="NHibernate.Caches.RtMemoryCache"
44
default="common.compile-all"
5-
description="Cache provider for NHibernate using MemoryCache"
5+
description="Cache provider for NHibernate using MemoryCache (System.Runtime.Caching)"
66
xmlns="http://nant.sf.net/release/0.85/nant.xsd">
77

88
<property name="root.dir" value=".." />

SysCache/NHibernate.Caches.SysCache/Async/SysCache.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414
using System.Web.Caching;
1515
using NHibernate.Cache;
1616
using System.Collections.Generic;
17-
using System.Threading;
18-
using System.Threading.Tasks;
1917
using NHibernate.Util;
2018

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

SysCache/NHibernate.Caches.SysCache/SysCache.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@
2626
using System.Web.Caching;
2727
using NHibernate.Cache;
2828
using System.Collections.Generic;
29-
using System.Threading;
30-
using System.Threading.Tasks;
3129
using NHibernate.Util;
3230

3331
namespace NHibernate.Caches.SysCache
@@ -76,9 +74,11 @@ public SysCache(string region)
7674
/// There are two (2) configurable parameters:
7775
/// <ul>
7876
/// <li>expiration = number of seconds to wait before expiring each item</li>
77+
/// <li>cache.use_sliding_expiration = a boolean, true for resetting a cached item expiration each time it is accessed.</li>
78+
/// <li>regionPrefix = a string for prefixing the region name.</li>
7979
/// <li>priority = a numeric cost of expiring each item, where 1 is a low cost, 5 is the highest, and 3 is normal. Only values 1 through 5 are valid.</li>
8080
/// </ul>
81-
/// All parameters are optional. The defaults are an expiration of 300 seconds and the default priority of 3.
81+
/// All parameters are optional. The defaults are an expiration of 300 seconds, no sliding expiration, no region prefix and the default priority of 3.
8282
/// </remarks>
8383
/// <exception cref="IndexOutOfRangeException">The "priority" property is not between 1 and 5</exception>
8484
/// <exception cref="ArgumentException">The "expiration" property could not be parsed.</exception>

0 commit comments

Comments
 (0)