Xml comments added and overloads removed from RedirectToRouteAssertions

Author: kevinkuszyk

src/FluentAssertions.Mvc3/RedirectToRouteAssertions.cs

@@ -9,20 +9,31 @@
 
 namespace FluentAssertions.Mvc
 {
+    /// <summary>
+    /// Contains a number of methods to assert that a <see cref="RedirectToRouteResult"/> is in the expected state.
+    /// </summary>
     public class RedirectToRouteAssertions : ReferenceTypeAssertions<RedirectToRouteResult, RedirectToRouteAssertions>
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="T:ContentResultAssertions" /> class.
+        /// </summary>
         public RedirectToRouteAssertions(RedirectToRouteResult subject)
         {
             Subject = subject;
         }
 
-        public RedirectToRouteAssertions WithPermanent(bool expectedPermanent)
-        {
-            WithPermanent(expectedPermanent, string.Empty, null);
-            return this;
-        }
-
-        public RedirectToRouteAssertions WithPermanent(bool expectedPermanent, string reason, params object[] reasonArgs)
+        /// <summary>
+        /// Asserts that the redirect is permanent.
+        /// </summary>
+        /// <param name="expectedPermanent">Should the redirect be permanent.</param>
+        /// <param name="reason">
+        /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion 
+        /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
+        /// </param>
+        /// <param name="reasonArgs">
+        /// Zero or more objects to format using the placeholders in <see cref="reason" />.
+        /// </param>
+        public RedirectToRouteAssertions WithPermanent(bool expectedPermanent, string reason = "", params object[] reasonArgs)
         {
             Execute.Verification
                     .BecauseOf(reason, reasonArgs)
@@ -31,13 +42,18 @@ public RedirectToRouteAssertions WithPermanent(bool expectedPermanent, string re
             return this;
         }
 
-        public RedirectToRouteAssertions WithRouteName(string expectedRouteName)
-        {
-            WithRouteName(expectedRouteName, string.Empty, null);
-            return this;
-        }
-
-        public RedirectToRouteAssertions WithRouteName(string expectedRouteName, string reason, params object[] reasonArgs)
+        /// <summary>
+        /// Asserts that the redirect has the expected route name.
+        /// </summary>
+        /// <param name="expectedRouteName">The expected route name.</param>
+        /// <param name="reason">
+        /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion 
+        /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
+        /// </param>
+        /// <param name="reasonArgs">
+        /// Zero or more objects to format using the placeholders in <see cref="reason" />.
+        /// </param>
+        public RedirectToRouteAssertions WithRouteName(string expectedRouteName, string reason = "", params object[] reasonArgs)
         {
             Execute.Verification
                     .BecauseOf(reason, reasonArgs)
@@ -47,49 +63,70 @@ public RedirectToRouteAssertions WithRouteName(string expectedRouteName, string
             return this;
         }
 
-        public RedirectToRouteAssertions WithRouteValue(string key, object expectedValue)
-        {
-            WithRouteValue(key, expectedValue, string.Empty, null);
-            return this;
-        }
-
-        public RedirectToRouteAssertions WithRouteValue(string key, object expectedValue, string reason, params object[] reasonArgs)
+        /// <summary>
+        /// Asserts that the redirect has the expected route value.
+        /// </summary>
+        /// <param name="key">The expected route value key.</param>
+        /// <param name="expectedValue">The expected route value.</param>
+        /// <param name="reason">
+        /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion 
+        /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
+        /// </param>
+        /// <param name="reasonArgs">
+        /// Zero or more objects to format using the placeholders in <see cref="reason" />.
+        /// </param>
+        public RedirectToRouteAssertions WithRouteValue(string key, object expectedValue, string reason = "", params object[] reasonArgs)
         {
             Subject.RouteValues.Should().Contain(new KeyValuePair<string, object>(key, expectedValue), reason, reasonArgs);
             return this;
         }
 
-        public RedirectToRouteAssertions WithController(string expectedControllerName)
-        {
-            WithController(expectedControllerName, string.Empty, null);
-            return this;
-        }
-
-        public RedirectToRouteAssertions WithController(string expectedControllerName, string reason, params object[] reasonArgs)
+        /// <summary>
+        /// Asserts that the redirect has the expected controller name.
+        /// </summary>
+        /// <param name="expectedControllerName">The expected controller name.</param>
+        /// <param name="reason">
+        /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion 
+        /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
+        /// </param>
+        /// <param name="reasonArgs">
+        /// Zero or more objects to format using the placeholders in <see cref="reason" />.
+        /// </param>
+        public RedirectToRouteAssertions WithController(string expectedControllerName, string reason = "", params object[] reasonArgs)
         {
             WithRouteValue("Controller", expectedControllerName, reason, reasonArgs);
             return this;
         }
 
-        public RedirectToRouteAssertions WithAction(string expectedAction)
-        {
-            WithAction(expectedAction, string.Empty, null);
-            return this;
-        }
-
-        public RedirectToRouteAssertions WithAction(string expectedArea, string reason, params object[] reasonArgs)
-        {
-            WithRouteValue("Action", expectedArea, reason, reasonArgs);
-            return this;
-        }
-
-        public RedirectToRouteAssertions WithArea(string expectedAction)
+        /// <summary>
+        /// Asserts that the redirect has the expected action.
+        /// </summary>
+        /// <param name="expectedAction">The expected action.</param>
+        /// <param name="reason">
+        /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion 
+        /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
+        /// </param>
+        /// <param name="reasonArgs">
+        /// Zero or more objects to format using the placeholders in <see cref="reason" />.
+        /// </param>
+        public RedirectToRouteAssertions WithAction(string expectedAction, string reason = "", params object[] reasonArgs)
         {
-            WithArea(expectedAction, string.Empty, null);
+            WithRouteValue("Action", expectedAction, reason, reasonArgs);
             return this;
         }
 
-        public RedirectToRouteAssertions WithArea(string expectedArea, string reason, params object[] reasonArgs)
+        /// <summary>
+        /// Asserts that the redirect has the expected area.
+        /// </summary>
+        /// <param name="expectedArea">The expected area.</param>
+        /// <param name="reason">
+        /// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion 
+        /// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
+        /// </param>
+        /// <param name="reasonArgs">
+        /// Zero or more objects to format using the placeholders in <see cref="reason" />.
+        /// </param>
+        public RedirectToRouteAssertions WithArea(string expectedArea, string reason = "", params object[] reasonArgs)
         {
             WithRouteValue("Area", expectedArea, reason, reasonArgs);
             return this;