Added missing xml comments for IRouteCache and default impl.

craiggwilson · Feb 3, 2012 · 1b2152b · 1b2152b
1 parent c51c9cb
commit 1b2152b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/src/Nancy/Routing/DefaultRouteCacheProvider.cs b/src/Nancy/Routing/DefaultRouteCacheProvider.cs
@@ -53,6 +53,10 @@ public DefaultRouteCacheProvider(Func<IRouteCache> routeCacheFactory)
             this.diagnosticObject = new RouteCacheDiagnostics(this);
         }
 
+        /// <summary>
+        /// Gets an instance of the route cache.
+        /// </summary>
+        /// <returns>An <see cref="IRouteCache"/> instance.</returns>
         public IRouteCache GetCache()
         {
             return this.RouteCacheFactory();

diff --git a/src/Nancy/Routing/IRouteCacheProvider.cs b/src/Nancy/Routing/IRouteCacheProvider.cs
@@ -3,12 +3,16 @@
     /// <summary>
     /// It's not safe for a module to take a dependency on the cache (cyclic dependency)
     /// 
-    /// We provide an IRouteCacheProvider instead.
+    /// We provide an <see cref="IRouteCacheProvider"/> instead.
     /// 
     /// It is *not* safe to call GetCache() inside a NancyModule constructor, although that shouldn't be necessary anyway.
     /// </summary>
     public interface IRouteCacheProvider
     {
+        /// <summary>
+        /// Gets an instance of the route cache.
+        /// </summary>
+        /// <returns>An <see cref="IRouteCache"/> instance.</returns>
         IRouteCache GetCache();
     }
 }