Added some more comments

oopanuga · Apr 27, 2016 · f43e8d9 · f43e8d9
1 parent 9a29a65
commit f43e8d9
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 12 deletions.
diff --git a/SeoPack/Helpers/UrlHelperExtensions.cs b/SeoPack/Helpers/UrlHelperExtensions.cs
@@ -1,6 +1,7 @@
 using SeoPack.Url;
 using System.Web.Mvc;
 using System.Web.Routing;
+using SeoPack.Url.UrlPolicy;
 
 namespace SeoPack.Helpers
 {
@@ -28,8 +29,9 @@ public static UrlSeoHelper UnpackSeo(this UrlHelper urlHelper)
         }
 
         /// <summary>
-        /// Generates a fully qualified Seo friendly URL for the specified route values. It uses 
-        /// a set of predefined url policies to achieve this.
+        /// Generates a fully qualified Seo friendly URL for the specified route values based on a set 
+        /// of predefined url policies. See <see cref="UrlPolicyConfiguration"/> on configuring url 
+        /// policies.
         /// </summary>
         /// <param name="urlHelper">The URL helper.</param>
         /// <param name="routeValues">The route values.</param>
@@ -40,8 +42,9 @@ public static string RouteSeoFriendlyUrl(this UrlHelper urlHelper, object routeV
         }
 
         /// <summary>
-        /// Generates a fully qualified Seo friendly URL for the specified route values. It uses 
-        /// a set of predefined url policies to achieve this.
+        /// Generates a fully qualified Seo friendly URL for the specified route values based on a set 
+        /// of predefined url policies. See <see cref="UrlPolicyConfiguration"/> on configuring url 
+        /// policies.
         /// </summary>
         /// <param name="urlHelper">The URL helper.</param>
         /// <param name="routeValues">The route values.</param>
@@ -52,8 +55,9 @@ public static string RouteSeoFriendlyUrl(this UrlHelper urlHelper, RouteValueDic
         }
 
         /// <summary>
-        /// Generates a fully qualified Seo friendly URL for the specified route values. It uses 
-        /// a set of predefined url policies to achieve this.
+        /// Generates a fully qualified Seo friendly URL for the specified route values based on a set 
+        /// of predefined url policies. See <see cref="UrlPolicyConfiguration"/> on configuring url 
+        /// policies.
         /// </summary>
         /// <param name="urlHelper">The URL helper.</param>
         /// <param name="routeName">Name of the route.</param>
@@ -64,8 +68,9 @@ public static string RouteSeoFriendlyUrl(this UrlHelper urlHelper, string routeN
         }
 
         /// <summary>
-        /// Generates a fully qualified Seo friendly URL for the specified route values. It uses 
-        /// a set of predefined url policies to achieve this.
+        /// Generates a fully qualified Seo friendly URL for the specified route values based on a set 
+        /// of predefined url policies. See <see cref="UrlPolicyConfiguration"/> on configuring url 
+        /// policies.
         /// </summary>
         /// <param name="urlHelper">The URL helper.</param>
         /// <param name="routeName">Name of the route.</param>
@@ -77,8 +82,9 @@ public static string RouteSeoFriendlyUrl(this UrlHelper urlHelper, string routeN
         }
 
         /// <summary>
-        /// Generates a fully qualified Seo friendly URL for the specified route values. It uses 
-        /// a set of predefined url policies to achieve this.
+        /// Generates a fully qualified Seo friendly URL for the specified route values based on a set 
+        /// of predefined url policies. See <see cref="UrlPolicyConfiguration"/> on configuring url 
+        /// policies.
         /// </summary>
         /// <param name="urlHelper">The URL helper.</param>
         /// <param name="routeName">Name of the route.</param>
@@ -91,8 +97,9 @@ public static string RouteSeoFriendlyUrl(this UrlHelper urlHelper, string routeN
         }
 
         /// <summary>
-        /// Generates a fully qualified Seo friendly URL for the specified route values. It uses 
-        /// a set of predefined url policies to achieve this.
+        /// Generates a fully qualified Seo friendly URL for the specified route values based on a set 
+        /// of predefined url policies. See <see cref="UrlPolicyConfiguration"/> on configuring url 
+        /// policies.
         /// </summary>
         /// <param name="urlHelper">The URL helper.</param>
         /// <param name="routeName">Name of the route.</param>

diff --git a/SeoPack/Url/UrlPolicy/UrlPolicyConfiguration.cs b/SeoPack/Url/UrlPolicy/UrlPolicyConfiguration.cs
@@ -3,10 +3,20 @@
 
 namespace SeoPack.Url.UrlPolicy
 {
+    /// <summary>
+    /// Represents a class used to configure a set of url policies that define the characteristics
+    /// of a Seo Friendly Url. See <see cref="SeoFriendlyUrl"/>
+    /// </summary>
     public static class UrlPolicyConfiguration
     {
         private static UrlPolicyBuilder _builder;
 
+        /// <summary>
+        /// Gets the configured URL policies.
+        /// </summary>
+        /// <value>
+        /// The URL policies.
+        /// </value>
         public static UrlPolicyBase[] UrlPolicies
         {
             get
@@ -16,12 +26,20 @@ public static UrlPolicyBase[] UrlPolicies
             }
         }
 
+        /// <summary>
+        /// Returns a url policy builder used to subsequently configure selected/added URL policies.
+        /// </summary>
+        /// <returns>The url policy builder.</returns>
         public static UrlPolicyBuilder Configure()
         {
             _builder = new UrlPolicyBuilder();
             return _builder;
         }
 
+        /// <summary>
+        /// Configures url policies based on the supplied URL policies.
+        /// </summary>
+        /// <param name="urlPolicies">The URL policies.</param>
         public static void Configure(IEnumerable<UrlPolicyBase> urlPolicies)
         {
             _builder = new UrlPolicyBuilder(urlPolicies.ToList());