Code documentation

Author: moonpyk

DevTrends.MvcDonutCaching/CacheSettingsManager.cs

@@ -12,6 +12,9 @@ public class CacheSettingsManager : ICacheSettingsManager
         private const string AspnetInternalProviderName = "AspNetInternalProvider";
         private readonly OutputCacheSection _outputCacheSection;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CacheSettingsManager"/> class.
+        /// </summary>
         public CacheSettingsManager()
         {
             try
@@ -29,13 +32,28 @@ public CacheSettingsManager()
             }
         }
 
+        /// <summary>
+        /// Returns the output cache provider settings.
+        /// </summary>
+        /// <returns>
+        /// A <see cref="ProviderSettings" /> instance.
+        /// </returns>
         public ProviderSettings RetrieveOutputCacheProviderSettings()
         {
             return _outputCacheSection.DefaultProviderName == AspnetInternalProviderName 
                 ? null 
                 : _outputCacheSection.Providers[_outputCacheSection.DefaultProviderName];
         }
 
+        /// <summary>
+        /// Returns an output cache profile for the asked <see cref="cacheProfileName" />.
+        /// </summary>
+        /// <param name="cacheProfileName">Name of the cache profile.</param>
+        /// <returns>
+        /// A <see cref="OutputCacheProfile" /> instance.
+        /// </returns>
+        /// <exception cref="System.Security.SecurityException">MvcDonutCaching does not have permission to read web.config section 'OutputCacheSettingsSection'.</exception>
+        /// <exception cref="System.Web.HttpException"></exception>
         public OutputCacheProfile RetrieveOutputCacheProfile(string cacheProfileName)
         {
             OutputCacheSettingsSection outputCacheSettingsSection;
@@ -62,6 +80,12 @@ public OutputCacheProfile RetrieveOutputCacheProfile(string cacheProfileName)
             throw new HttpException(string.Format("The '{0}' cache profile is not defined.  Please define it in the configuration file.", cacheProfileName));
         }
 
+        /// <summary>
+        /// Return a value indicating whether caching is globally enabled.
+        /// </summary>
+        /// <value>
+        /// <c>true</c> if caching is globally enabled; otherwise, <c>false</c>.
+        /// </value>
         public bool IsCachingEnabledGlobally
         {
             get { return _outputCacheSection.EnableOutputCache; }

DevTrends.MvcDonutCaching/DonutOutputCacheAttribute.cs

@@ -22,8 +22,15 @@ public class DonutOutputCacheAttribute : ActionFilterAttribute, IExceptionFilter
         private bool? _noStore;
         private OutputCacheOptions? _options;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DonutOutputCacheAttribute"/> class.
+        /// </summary>
         public DonutOutputCacheAttribute() : this(new KeyBuilder()) { }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DonutOutputCacheAttribute"/> class.
+        /// </summary>
+        /// <param name="keyBuilder">The key builder.</param>
         public DonutOutputCacheAttribute(IKeyBuilder keyBuilder) :
             this(
                new KeyGenerator(keyBuilder),
@@ -34,6 +41,14 @@ public DonutOutputCacheAttribute(IKeyBuilder keyBuilder) :
         )
         { }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DonutOutputCacheAttribute"/> class.
+        /// </summary>
+        /// <param name="keyGenerator">The key generator.</param>
+        /// <param name="outputCacheManager">The output cache manager.</param>
+        /// <param name="donutHoleFiller">The donut hole filler.</param>
+        /// <param name="cacheSettingsManager">The cache settings manager.</param>
+        /// <param name="cacheHeadersHelper">The cache headers helper.</param>
         protected DonutOutputCacheAttribute(
             IKeyGenerator keyGenerator, IReadWriteOutputCacheManager outputCacheManager,
             IDonutHoleFiller donutHoleFiller, ICacheSettingsManager cacheSettingsManager, ICacheHeadersHelper cacheHeadersHelper

DevTrends.MvcDonutCaching/HtmlHelperExtensions.cs

@@ -9,6 +9,12 @@ public static class HtmlHelperExtensions
     {
         private static IActionSettingsSerialiser _serialiser;
 
+        /// <summary>
+        /// Gets or sets the serialiser.
+        /// </summary>
+        /// <value>
+        /// The serialiser.
+        /// </value>
         public static IActionSettingsSerialiser Serialiser
         {
             get
@@ -206,4 +212,4 @@ private static string GetSerialisedActionSettings(string actionName, string cont
             return Serialiser.Serialise(actionSettings);
         }
     }
-}
+}

DevTrends.MvcDonutCaching/MemoryCacheProvider.cs

@@ -40,4 +40,4 @@ IEnumerator IEnumerable.GetEnumerator()
             return GetEnumerator();
         }
     }
-}
+}

DevTrends.MvcDonutCaching/OutputCache.cs

@@ -38,6 +38,9 @@ private OutputCache()
         {
         }
 
+        /// <summary>
+        /// Gets the current <see cref="OutputCacheManager"/> instance.
+        /// </summary>
         public static OutputCacheProvider Instance
         {
             get;

DevTrends.MvcDonutCaching/OutputCacheManager.cs

@@ -23,16 +23,35 @@ public OutputCacheManager(OutputCacheProvider outputCacheProvider, IKeyBuilder k
             _keyBuilder = keyBuilder;
         }
 
+        /// <summary>
+        /// Gets the key builder.
+        /// </summary>
+        /// <value>
+        /// The key builder.
+        /// </value>
         public IKeyBuilder KeyBuilder
         {
             get { return _keyBuilder; }
         }
 
+        /// <summary>
+        /// Add sthe given <see cref="cacheItem" /> in the cache.
+        /// </summary>
+        /// <param name="key">The cache key to add.</param>
+        /// <param name="cacheItem">The cache item to add.</param>
+        /// <param name="utcExpiry">The cache item UTC expiry date and time.</param>
         public void AddItem(string key, CacheItem cacheItem, DateTime utcExpiry)
         {
             _outputCacheProvider.Add(key, cacheItem, utcExpiry);
         }
 
+        /// <summary>
+        /// Retrieves a cache item the given the <see cref="key" />.
+        /// </summary>
+        /// <param name="key">The key.</param>
+        /// <returns>
+        /// A <see cref="CacheItem" /> instance on cache hit, null otherwise.
+        /// </returns>
         public CacheItem GetItem(string key)
         {
             return _outputCacheProvider.Get(key) as CacheItem;