Added documentation summary on route test builders

Author: ivaylokenov

src/MyTested.Mvc/Builders/Contracts/Http/IHttpRequestBuilder.cs

@@ -2,26 +2,79 @@
 {
     using System;
 
+    /// <summary>
+    /// Used for testing <see cref="Microsoft.AspNetCore.Http.HttpResponse"/> cookie.
+    /// </summary>
     public interface IResponseCookieTestBuilder
     {
+        /// <summary>
+        /// Sets the expected <see cref="Microsoft.Net.Http.Headers.SetCookieHeaderValue.Name"/> of the tested cookie.
+        /// </summary>
+        /// <param name="name">Name to set on the cookie.</param>
+        /// <returns>The same <see cref="IAndHttpResponseTestBuilder"/>.</returns>
         IAndResponseCookieTestBuilder WithName(string name);
 
+        /// <summary>
+        /// Tests whether the <see cref="Microsoft.Net.Http.Headers.SetCookieHeaderValue.Value"/> property is the same as the provided one.
+        /// </summary>
+        /// <param name="value">Expected value of the cookie.</param>
+        /// <returns>The same <see cref="IAndHttpResponseTestBuilder"/>.</returns>
         IAndResponseCookieTestBuilder WithValue(string value);
 
+        /// <summary>
+        /// Tests whether the <see cref="Microsoft.Net.Http.Headers.SetCookieHeaderValue.Value"/> passes the provided assertions.
+        /// </summary>
+        /// <param name="assertions">Action containing assertions on the cookie value.</param>
+        /// <returns>The same <see cref="IAndHttpResponseTestBuilder"/>.</returns>
         IAndResponseCookieTestBuilder WithValue(Action<string> assertions);
-        
+
+        /// <summary>
+        /// Tests whether the <see cref="Microsoft.Net.Http.Headers.SetCookieHeaderValue.Value"/> passes the provided predicate.
+        /// </summary>
+        /// <param name="predicate">Predicate testing the cookie value.</param>
+        /// <returns>The same <see cref="IAndHttpResponseTestBuilder"/>.</returns>
         IAndResponseCookieTestBuilder WithValue(Func<string, bool> predicate);
 
+        /// <summary>
+        /// Tests whether the <see cref="Microsoft.Net.Http.Headers.SetCookieHeaderValue.Domain"/> property is the same as provided one.
+        /// </summary>
+        /// <param name="domain">Expected domain of the cookie.</param>
+        /// <returns>The same <see cref="IAndHttpResponseTestBuilder"/>.</returns>
         IAndResponseCookieTestBuilder WithDomain(string domain);
 
+        /// <summary>
+        /// Tests whether the <see cref="Microsoft.Net.Http.Headers.SetCookieHeaderValue.Expires"/> property is the same as provided one.
+        /// </summary>
+        /// <param name="expires">Expected expiration date time offset of the cookie.</param>
+        /// <returns>The same <see cref="IAndHttpResponseTestBuilder"/>.</returns>
         IAndResponseCookieTestBuilder WithExpired(DateTimeOffset? expires);
 
+        /// <summary>
+        /// Tests whether the <see cref="Microsoft.Net.Http.Headers.SetCookieHeaderValue.HttpOnly"/> property is the same as provided one.
+        /// </summary>
+        /// <param name="httpOnly">Expected <see cref="Microsoft.Net.Http.Headers.SetCookieHeaderValue.HttpOnly"/> property of the cookie.</param>
+        /// <returns>The same <see cref="IAndHttpResponseTestBuilder"/>.</returns>
         IAndResponseCookieTestBuilder WithHttpOnly(bool httpOnly);
 
+        /// <summary>
+        /// Tests whether the <see cref="Microsoft.Net.Http.Headers.SetCookieHeaderValue.MaxAge"/> property is the same as provided one.
+        /// </summary>
+        /// <param name="maxAge">Expected <see cref="Microsoft.Net.Http.Headers.SetCookieHeaderValue.MaxAge"/> property of the cookie.</param>
+        /// <returns>The same <see cref="IAndHttpResponseTestBuilder"/>.</returns>
         IAndResponseCookieTestBuilder WithMaxAge(TimeSpan? maxAge);
 
+        /// <summary>
+        /// Tests whether the <see cref="Microsoft.Net.Http.Headers.SetCookieHeaderValue.Path"/> property is the same as provided one.
+        /// </summary>
+        /// <param name="path">Expected <see cref="Microsoft.Net.Http.Headers.SetCookieHeaderValue.Path"/> property of the cookie.</param>
+        /// <returns>The same <see cref="IAndHttpResponseTestBuilder"/>.</returns>
         IAndResponseCookieTestBuilder WithPath(string path);
 
+        /// <summary>
+        /// Tests whether the <see cref="Microsoft.Net.Http.Headers.SetCookieHeaderValue.Secure"/> property is the same as provided one.
+        /// </summary>
+        /// <param name="secure">Expected <see cref="Microsoft.Net.Http.Headers.SetCookieHeaderValue.Secure"/> property of the cookie.</param>
+        /// <returns>The same <see cref="IAndHttpResponseTestBuilder"/>.</returns>
         IAndResponseCookieTestBuilder WithSecure(bool secure);
     }
 }

src/MyTested.Mvc/Builders/Contracts/Http/IHttpResponseTestBuilder.cs

@@ -1,15 +1,15 @@
 namespace MyTested.Mvc.Builders.Contracts.Models
 {
     /// <summary>
-    /// Used for adding AndAlso() method to the the model error tests.
+    /// Used for adding AndAlso() method to the <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> error tests.
     /// </summary>
     /// <typeparam name="TModel">Model from invoked action in ASP.NET Core MVC controller.</typeparam>
     public interface IAndModelErrorTestBuilder<TModel> : IModelErrorTestBuilder<TModel>
     {
         /// <summary>
-        /// AndAlso method for better readability when chaining error message tests.
+        /// AndAlso method for better readability when chaining <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> error message tests.
         /// </summary>
-        /// <returns>Model error details test builder.</returns>
+        /// <returns>The same <see cref="IModelErrorTestBuilder{TModel}"/>.</returns>
         IModelErrorTestBuilder<TModel> AndAlso();
     }
 }

src/MyTested.Mvc/Builders/Contracts/Http/IResponseCookieTestBuilder.cs

@@ -3,23 +3,23 @@
     using System;
 
     /// <summary>
-    /// Used for testing the response model members.
+    /// Used for testing the model members.
     /// </summary>
-    /// <typeparam name="TResponseModel">Response model from invoked action in ASP.NET Core MVC controller.</typeparam>
+    /// <typeparam name="TResponseModel">Model from invoked action in ASP.NET Core MVC controller.</typeparam>
     public interface IModelDetailsTestBuilder<TResponseModel> : IModelErrorTestBuilder<TResponseModel>
     {
         /// <summary>
-        /// Tests whether the returned response model from the invoked action passes given assertions.
+        /// Tests whether the returned model from the invoked action passes given assertions.
         /// </summary>
-        /// <param name="assertions">Action containing all assertions on the response model.</param>
-        /// <returns>Builder for testing the response model errors.</returns>
+        /// <param name="assertions">Action containing all assertions on the model.</param>
+        /// <returns>Test builder of <see cref="IModelErrorTestBuilder{TResponseModel}"/>.</returns>
         IModelErrorTestBuilder<TResponseModel> Passing(Action<TResponseModel> assertions);
 
         /// <summary>
-        /// Tests whether the returned response model from the invoked action passes given predicate.
+        /// Tests whether the returned model from the invoked action passes given predicate.
         /// </summary>
-        /// <param name="predicate">Predicate testing the response model.</param>
-        /// <returns>Builder for testing the response model errors.</returns>
+        /// <param name="predicate">Predicate testing the model.</param>
+        /// <returns>Test builder of <see cref="IModelErrorTestBuilder{TResponseModel}"/>.</returns>
         IModelErrorTestBuilder<TResponseModel> Passing(Func<TResponseModel, bool> predicate);
     }
 }

src/MyTested.Mvc/Builders/Contracts/Models/IAndModelErrorTestBuilder.cs

@@ -5,68 +5,68 @@
     using Base;
 
     /// <summary>
-    /// Used for testing specific model errors.
+    /// Used for testing specific <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> errors.
     /// </summary>
     /// <typeparam name="TModel">Model from invoked action in ASP.NET Core MVC controller.</typeparam>
     public interface IModelErrorDetailsTestBuilder<TModel> : IBaseTestBuilderWithModel<TModel>
     {
         /// <summary>
-        /// Tests whether particular error message is equal to given message.
+        /// Tests whether the error message is equal to given message.
         /// </summary>
-        /// <param name="errorMessage">Expected error message for particular key.</param>
-        /// <returns>The original model error test builder.</returns>
+        /// <param name="errorMessage">Expected error message.</param>
+        /// <returns>Test builder of <see cref="IAndModelErrorTestBuilder{TModel}"/>.</returns>
         IAndModelErrorTestBuilder<TModel> ThatEquals(string errorMessage);
 
         /// <summary>
-        /// Tests whether particular error message begins with given message.
+        /// Tests whether the error message begins with given message.
         /// </summary>
-        /// <param name="beginMessage">Expected beginning for particular error message.</param>
-        /// <returns>The original model error test builder.</returns>
+        /// <param name="beginMessage">Expected beginning for the error message.</param>
+        /// <returns>Test builder of <see cref="IAndModelErrorTestBuilder{TModel}"/>.</returns>
         IAndModelErrorTestBuilder<TModel> BeginningWith(string beginMessage);
 
         /// <summary>
-        /// Tests whether particular error message ends with given message.
+        /// Tests whether the error message ends with given message.
         /// </summary>
-        /// <param name="endMessage">Expected ending for particular error message.</param>
-        /// <returns>The original model error test builder.</returns>
+        /// <param name="endMessage">Expected ending for the error message.</param>
+        /// <returns>Test builder of <see cref="IAndModelErrorTestBuilder{TModel}"/>.</returns>
         IAndModelErrorTestBuilder<TModel> EndingWith(string endMessage);
 
         /// <summary>
-        /// Tests whether particular error message contains given message.
+        /// Tests whether the error message contains given message.
         /// </summary>
-        /// <param name="containsMessage">Expected containing string for particular error message.</param>
-        /// <returns>The original model error test builder.</returns>
+        /// <param name="containsMessage">Expected containing string for the error message.</param>
+        /// <returns>Test builder of <see cref="IAndModelErrorTestBuilder{TModel}"/>.</returns>
         IAndModelErrorTestBuilder<TModel> Containing(string containsMessage);
 
         /// <summary>
-        /// Tests whether tested action's model state contains error by key.
+        /// Tests whether the tested <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> contains error by key.
         /// </summary>
         /// <param name="errorKey">Error key to search for.</param>
-        /// <returns>Model error details test builder.</returns>
+        /// <returns>The same <see cref="IModelErrorDetailsTestBuilder{TModel}"/>.</returns>
         IModelErrorDetailsTestBuilder<TModel> ContainingError(string errorKey);
 
         /// <summary>
-        /// Tests whether tested action's model state contains error by member expression.
+        /// Tests whether the tested <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> contains error by member expression.
         /// </summary>
         /// <typeparam name="TMember">Type of the member which will be tested for errors.</typeparam>
         /// <param name="memberWithError">Member expression for the tested member.</param>
-        /// <returns>Model error details test builder.</returns>
+        /// <returns>The same <see cref="IModelErrorDetailsTestBuilder{TModel}"/>.</returns>
         IModelErrorDetailsTestBuilder<TModel> ContainingErrorFor<TMember>(
             Expression<Func<TModel, TMember>> memberWithError);
 
         /// <summary>
-        /// Tests whether tested action's model state contains no error by member expression.
+        /// Tests whether tested <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> contains no error by member expression.
         /// </summary>
         /// <typeparam name="TMember">Type of the member which will be tested for no errors.</typeparam>
         /// <param name="memberWithNoError">Member expression for the tested member.</param>
-        /// <returns>Model error details test builder.</returns>
+        /// <returns>Test builder of <see cref="IModelErrorTestBuilder{TModel}"/> type.</returns>
         IModelErrorTestBuilder<TModel> ContainingNoErrorFor<TMember>(
             Expression<Func<TModel, TMember>> memberWithNoError);
 
         /// <summary>
         /// AndAlso method for better readability when chaining error message tests.
         /// </summary>
-        /// <returns>Model error details test builder.</returns>
+        /// <returns>Test builder of <see cref="IModelErrorTestBuilder{TModel}"/> type.</returns>
         IModelErrorTestBuilder<TModel> AndAlso();
     }
 }

src/MyTested.Mvc/Builders/Contracts/Models/IModelDetailsTestBuilder.cs

@@ -3,14 +3,14 @@
     using Base;
 
     /// <summary>
-    /// Used for testing model errors.
+    /// Used for testing <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> errors.
     /// </summary>
     public interface IModelErrorTestBuilder : IBaseTestBuilderWithInvokedAction
     {
         /// <summary>
-        /// Tests whether tested action's model state is valid.
+        /// Tests whether the tested <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> is valid.
         /// </summary>
-        /// <returns>Base test builder.</returns>
+        /// <returns>Test builder of <see cref="IBaseTestBuilderWithInvokedAction"/> type.</returns>
         IBaseTestBuilderWithInvokedAction ContainingNoErrors();
     }
 }

src/MyTested.Mvc/Builders/Contracts/Models/IModelErrorDetailsTestBuilder.cs

@@ -5,32 +5,32 @@
     using Base;
 
     /// <summary>
-    /// Used for testing model errors.
+    /// Used for testing <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> errors.
     /// </summary>
     /// <typeparam name="TModel">Model from invoked action in ASP.NET Core MVC controller.</typeparam>
     public interface IModelErrorTestBuilder<TModel> : IModelErrorTestBuilder, IBaseTestBuilderWithModel<TModel>
     {
         /// <summary>
-        /// Tests whether tested action's model state contains error by key.
+        /// Tests whether the tested <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> contains error by key.
         /// </summary>
         /// <param name="errorKey">Error key to search for.</param>
-        /// <returns>Model error details test builder.</returns>
+        /// <returns>Test builder of <see cref="IModelErrorDetailsTestBuilder{TModel}"/> type.</returns>
         IModelErrorDetailsTestBuilder<TModel> ContainingError(string errorKey);
 
         /// <summary>
-        /// Tests whether tested action's model state contains error by member expression.
+        /// Tests whether the tested <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> contains error by member expression.
         /// </summary>
         /// <typeparam name="TMember">Type of the member which will be tested for errors.</typeparam>
         /// <param name="memberWithError">Member expression for the tested member.</param>
-        /// <returns>Model error details test builder.</returns>
+        /// <returns>Test builder of <see cref="IModelErrorDetailsTestBuilder{TModel}"/> type.</returns>
         IModelErrorDetailsTestBuilder<TModel> ContainingErrorFor<TMember>(Expression<Func<TModel, TMember>> memberWithError);
 
         /// <summary>
-        /// Tests whether tested action's model state contains no error by member expression.
+        /// Tests whether the tested <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> contains no error by member expression.
         /// </summary>
         /// <typeparam name="TMember">Type of the member which will be tested for no errors.</typeparam>
         /// <param name="memberWithNoError">Member expression for the tested member.</param>
-        /// <returns>This instance in order to support method chaining.</returns>
+        /// <returns>The same <see cref="IAndModelErrorTestBuilder{TModel}"/>.</returns>
         IAndModelErrorTestBuilder<TModel> ContainingNoErrorFor<TMember>(
             Expression<Func<TModel, TMember>> memberWithNoError);
     }

src/MyTested.Mvc/Builders/Contracts/Models/IModelErrorTestBuilder.cs

@@ -8,7 +8,7 @@ public interface IAndResolvedRouteTestBuilder : IResolvedRouteTestBuilder
         /// <summary>
         /// AndAlso method for better readability when building route tests.
         /// </summary>
-        /// <returns>The same route builder.</returns>
+        /// <returns>The same <see cref="IResolvedRouteTestBuilder"/>.</returns>
         IResolvedRouteTestBuilder AndAlso();
     }
 }