Added documentation on some of the action results

Author: ivaylokenov

src/MyTested.Mvc/Builders/Base/BaseTestBuilderWithInvokedAction.cs

@@ -8,32 +8,34 @@
     using ShouldPassFor;
 
     /// <summary>
-    /// Base class for test builders with caught exception.
+    /// Base class for test builders with invoked action.
     /// </summary>
     public abstract class BaseTestBuilderWithInvokedAction
         : BaseTestBuilderWithAction, IBaseTestBuilderWithInvokedAction
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="BaseTestBuilderWithInvokedAction" /> class.
         /// </summary>
-        /// <param name="controller">Controller on which the action will be tested.</param>
-        /// <param name="actionName">Name of the tested action.</param>
-        /// <param name="caughtException">Caught exception during the action execution.</param>
-        /// <param name="actionAttributes">Collected action attributes from the method call.</param>
+        /// <param name="testContext">Controller test context containing data about the currently executed assertion chain.</param>
         protected BaseTestBuilderWithInvokedAction(ControllerTestContext testContext)
             : base(testContext)
         {
         }
 
+        /// <summary>
+        /// Gets the caught exception. Returns null, if such does not exist.
+        /// </summary>
+        /// <value>Result of type <see cref="Exception"/>.</value>
         internal Exception CaughtException => this.TestContext.CaughtException;
 
+        /// <inheritdoc />
         public new IShouldPassForTestBuilderWithInvokedAction ShouldPassFor()
             => new ShouldPassForTestBuilderWithInvokedAction(this.TestContext);
 
         /// <summary>
-        /// Creates new AndProvideTestBuilder.
+        /// Creates new <see cref="AndProvideTestBuilder"/>.
         /// </summary>
-        /// <returns>Base test builder.</returns>
+        /// <returns>Test builder of type <see cref="IBaseTestBuilderWithInvokedAction"/>.</returns>
         protected IBaseTestBuilderWithInvokedAction NewAndProvideTestBuilder()
             => new AndProvideTestBuilder(this.TestContext);
     }

src/MyTested.Mvc/Builders/Base/BaseTestBuilderWithModel.cs

@@ -14,15 +14,13 @@ public abstract class BaseTestBuilderWithModel<TModel> : BaseTestBuilderWithInvo
         /// <summary>
         /// Initializes a new instance of the <see cref="BaseTestBuilderWithModel{TModel}" /> class.
         /// </summary>
-        /// <param name="controller">Controller on which the action will be tested.</param>
-        /// <param name="actionName">Name of the tested action.</param>
-        /// <param name="caughtException">Caught exception during the action execution.</param>
-        /// <param name="model">Model returned from action result.</param>
+        /// <param name="testContext">Controller test context containing data about the currently executed assertion chain.</param>
         protected BaseTestBuilderWithModel(ControllerTestContext testContext)
             : base(testContext)
         {
         }
 
+        /// <inheritdoc />
         public new IShouldPassForTestBuilderWithModel<TModel> ShouldPassFor()
         {
             return new ShouldPassForTestBuilderWithModel<TModel>(this.TestContext);

src/MyTested.Mvc/Builders/Base/BaseTestBuilderWithResponseModel.cs

@@ -17,7 +17,7 @@
     using Utilities.Validators;
 
     /// <summary>
-    /// Base class for all response model test builders.
+    /// Base class for all test builders with response model.
     /// </summary>
     /// <typeparam name="TActionResult">Result from invoked action in ASP.NET Core MVC controller.</typeparam>
     public abstract class BaseTestBuilderWithResponseModel<TActionResult>
@@ -29,10 +29,7 @@ public abstract class BaseTestBuilderWithResponseModel<TActionResult>
         /// <summary>
         /// Initializes a new instance of the <see cref="BaseTestBuilderWithResponseModel{TActionResult}" /> class.
         /// </summary>
-        /// <param name="controller">Controller on which the action will be tested.</param>
-        /// <param name="actionName">Name of the tested action.</param>
-        /// <param name="caughtException">Caught exception during the action execution.</param>
-        /// <param name="actionResult">Result from the tested action.</param>
+        /// <param name="testContext">Controller test context containing data about the currently executed assertion chain.</param>
         protected BaseTestBuilderWithResponseModel(ControllerTestContext testContext)
             : base(testContext)
         {
@@ -52,11 +49,7 @@ protected BaseTestBuilderWithResponseModel(ControllerTestContext testContext)
         /// <value>String value.</value>
         protected string OfTypeErrorMessageFormat { get; set; }
 
-        /// <summary>
-        /// Tests whether certain type of response model is returned from the invoked action.
-        /// </summary>
-        /// <typeparam name="TResponseModel">Type of the response model.</typeparam>
-        /// <returns>Builder for testing the response model errors.</returns>
+        /// <inheritdoc />
         public IModelDetailsTestBuilder<TResponseModel> WithResponseModelOfType<TResponseModel>()
         {
             var actualResponseDataType = this.GetReturnType();
@@ -80,12 +73,7 @@ public IModelDetailsTestBuilder<TResponseModel> WithResponseModelOfType<TRespons
             return new ModelDetailsTestBuilder<TResponseModel>(this.TestContext);
         }
 
-        /// <summary>
-        /// Tests whether a deeply equal object to the provided one is returned from the invoked action.
-        /// </summary>
-        /// <typeparam name="TResponseModel">Type of the response model.</typeparam>
-        /// <param name="expectedModel">Expected model to be returned.</param>
-        /// <returns>Builder for testing the response model errors.</returns>
+        /// <inheritdoc />
         public IModelDetailsTestBuilder<TResponseModel> WithResponseModel<TResponseModel>(TResponseModel expectedModel)
         {
             this.WithResponseModelOfType<TResponseModel>();
@@ -107,7 +95,7 @@ public IModelDetailsTestBuilder<TResponseModel> WithResponseModel<TResponseModel
         /// <summary>
         /// Tests whether action result has the same status code as the provided one.
         /// </summary>
-        /// <param name="statusCode">Status code.</param>
+        /// <param name="statusCode">Status code as integer.</param>
         protected void ValidateStatusCode(int statusCode)
         {
             this.ValidateStatusCode((HttpStatusCode)statusCode);
@@ -116,7 +104,7 @@ protected void ValidateStatusCode(int statusCode)
         /// <summary>
         /// Tests whether action result has the same status code as the provided HttpStatusCode.
         /// </summary>
-        /// <param name="statusCode">HttpStatusCode enumeration.</param>
+        /// <param name="statusCode"><see cref="HttpStatusCode"/> enumeration.</param>
         protected void ValidateStatusCode(HttpStatusCode statusCode)
         {
             HttpStatusCodeValidator.ValidateHttpStatusCode(
@@ -137,7 +125,7 @@ protected void ValidateContainingOfContentType(string contentType)
         /// <summary>
         /// Tests whether action result contains the same content type as the provided MediaTypeHeaderValue.
         /// </summary>
-        /// <param name="contentType">Expected content type as MediaTypeHeaderValue.</param>
+        /// <param name="contentType">Expected content type as <see cref="MediaTypeHeaderValue"/>.</param>
         protected void ValidateContainingOfContentType(MediaTypeHeaderValue contentType)
         {
             ContentTypeValidator.ValidateContainingOfContentType(
@@ -167,7 +155,7 @@ protected void ValidateContentTypes(params string[] contentTypes)
         /// <summary>
         /// Tests whether action result contains the same content types as the provided ones.
         /// </summary>
-        /// <param name="contentTypes">Expected content types as enumerable of MediaTypeHeaderValue.</param>
+        /// <param name="contentTypes">Expected content types as enumerable of <see cref="MediaTypeHeaderValue"/>.</param>
         protected void ValidateContentTypes(IEnumerable<MediaTypeHeaderValue> contentTypes)
         {
             ContentTypeValidator.ValidateContentTypes(
@@ -179,7 +167,7 @@ protected void ValidateContentTypes(IEnumerable<MediaTypeHeaderValue> contentTyp
         /// <summary>
         /// Tests whether action result contains the same content types as the provided ones.
         /// </summary>
-        /// <param name="contentTypes">Expected content types as MediaTypeHeaderValue parameters.</param>
+        /// <param name="contentTypes">Expected content types as <see cref="MediaTypeHeaderValue"/> parameters.</param>
         protected void ValidateContentTypes(params MediaTypeHeaderValue[] contentTypes)
         {
             this.ValidateContentTypes(contentTypes.AsEnumerable());
@@ -188,7 +176,7 @@ protected void ValidateContentTypes(params MediaTypeHeaderValue[] contentTypes)
         /// <summary>
         /// Tests whether action result contains the same output formatter as the provided one.
         /// </summary>
-        /// <param name="outputFormatter">Expected instance of IOutputFormatter.</param>
+        /// <param name="outputFormatter">Expected instance of <see cref="IOutputFormatter"/>.</param>
         protected void ValidateContainingOfOutputFormatter(IOutputFormatter outputFormatter)
         {
             OutputFormatterValidator.ValidateContainingOfOutputFormatter(
@@ -200,7 +188,7 @@ protected void ValidateContainingOfOutputFormatter(IOutputFormatter outputFormat
         /// <summary>
         /// Tests whether action result contains type of output formatter as the provided one.
         /// </summary>
-        /// <typeparam name="TOutputFormatter">Expected type of IOutputFormatter.</typeparam>
+        /// <typeparam name="TOutputFormatter">Expected type of <see cref="IOutputFormatter"/>.</typeparam>
         protected void ValidateContainingOutputFormatterOfType<TOutputFormatter>()
             where TOutputFormatter : IOutputFormatter
         {
@@ -212,7 +200,7 @@ protected void ValidateContainingOutputFormatterOfType<TOutputFormatter>()
         /// <summary>
         /// Tests whether action result contains the same output formatters as the provided ones.
         /// </summary>
-        /// <param name="outputFormatters">Expected enumerable of IOutputFormatter.</param>
+        /// <param name="outputFormatters">Expected enumerable of <see cref="IOutputFormatter"/>.</param>
         protected void ValidateOutputFormatters(IEnumerable<IOutputFormatter> outputFormatters)
         {
             OutputFormatterValidator.ValidateOutputFormatters(
@@ -224,7 +212,7 @@ protected void ValidateOutputFormatters(IEnumerable<IOutputFormatter> outputForm
         /// <summary>
         /// Tests whether action result contains the same output formatters as the provided ones.
         /// </summary>
-        /// <param name="outputFormatters">Expected IOutputFormatter parameters.</param>
+        /// <param name="outputFormatters">Expected <see cref="IOutputFormatter"/> parameters.</param>
         protected void ValidateOutputFormatters(params IOutputFormatter[] outputFormatters)
             => this.ValidateOutputFormatters(outputFormatters.AsEnumerable());
 

src/MyTested.Mvc/Builders/Base/BaseTestBuilderWithViewFeature.cs

@@ -1,11 +1,11 @@
 namespace MyTested.Mvc.Builders.Base
 {
-    using Builders.ShouldPassFor;
     using Contracts.Base;
     using Contracts.Models;
     using Contracts.ShouldPassFor;
     using Internal.TestContexts;
     using Microsoft.AspNetCore.Mvc;
+    using ShouldPassFor;
 
     /// <summary>
     /// Base class for all test builders with view features.
@@ -18,30 +18,19 @@ public abstract class BaseTestBuilderWithViewFeature<TViewResult>
         /// <summary>
         /// Initializes a new instance of the <see cref="BaseTestBuilderWithViewFeature{TActionResult}" /> class.
         /// </summary>
-        /// <param name="controller">Controller on which the action will be tested.</param>
-        /// <param name="actionName">Name of the tested action.</param>
-        /// <param name="caughtException">Caught exception during the action execution.</param>
-        /// <param name="viewResult">Result from the tested action.</param>
+        /// <param name="testContext">Controller test context containing data about the currently executed assertion chain.</param>
         protected BaseTestBuilderWithViewFeature(ControllerTestContext testContext)
             : base(testContext)
         {
         }
 
-        /// <summary>
-        /// Tests whether view result contains deeply equal model object as the provided one.
-        /// </summary>
-        /// <typeparam name="TModel">Type of model object.</typeparam>
-        /// <param name="model">Model object.</param>
-        /// <returns>Model details test builder.</returns>
+        /// <inheritdoc />
         public IModelDetailsTestBuilder<TModel> WithModel<TModel>(TModel model) => this.WithResponseModel(model);
 
-        /// <summary>
-        /// Tests whether view result contains model object of the provided type.
-        /// </summary>
-        /// <typeparam name="TModel">Type of model object.</typeparam>
-        /// <returns>Model details test builder.</returns>
+        /// <inheritdoc />
         public IModelDetailsTestBuilder<TModel> WithModelOfType<TModel>() => this.WithResponseModelOfType<TModel>();
-        
+
+        /// <inheritdoc />
         IShouldPassForTestBuilderWithActionResult<ActionResult> IBaseTestBuilderWithActionResult<ActionResult>.ShouldPassFor()
             => new ShouldPassForTestBuilderWithActionResult<ActionResult>(this.TestContext);
     }

src/MyTested.Mvc/Builders/Contracts/ActionResults/BadRequest/IAndBadRequestTestBuilder.cs

@@ -1,14 +1,14 @@
 namespace MyTested.Mvc.Builders.Contracts.ActionResults.BadRequest
 {
     /// <summary>
-    /// Used for adding AndAlso() method to the HTTP bad request response tests.
+    /// Used for adding AndAlso() method to the HTTP bad request result tests.
     /// </summary>
     public interface IAndBadRequestTestBuilder : IBadRequestTestBuilder
     {
         /// <summary>
         /// AndAlso method for better readability when chaining HTTP bad request result tests.
         /// </summary>
-        /// <returns>HTTP bad request result test builder.</returns>
+        /// <returns>The same <see cref="IBadRequestTestBuilder"/>.</returns>
         IBadRequestTestBuilder AndAlso();
     }
 }

src/MyTested.Mvc/Builders/Contracts/ActionResults/BadRequest/IBadRequestErrorMessageTestBuilder.cs

@@ -11,28 +11,28 @@ public interface IBadRequestErrorMessageTestBuilder : IBaseTestBuilderWithInvoke
         /// Tests whether particular error message is equal to given message.
         /// </summary>
         /// <param name="errorMessage">Expected error message for particular key.</param>
-        /// <returns>HTTP bad request test builder.</returns>
+        /// <returns>Test builder of type <see cref="IAndBadRequestTestBuilder"/>.</returns>
         IAndBadRequestTestBuilder ThatEquals(string errorMessage);
 
         /// <summary>
         /// Tests whether particular error message begins with given message.
         /// </summary>
         /// <param name="beginMessage">Expected beginning for particular error message.</param>
-        /// <returns>HTTP bad request test builder.</returns>
+        /// <returns>Test builder of type <see cref="IAndBadRequestTestBuilder"/>.</returns>
         IAndBadRequestTestBuilder BeginningWith(string beginMessage);
 
         /// <summary>
         /// Tests whether particular error message ends with given message.
         /// </summary>
         /// <param name="endMessage">Expected ending for particular error message.</param>
-        /// <returns>HTTP bad request test builder.</returns>
+        /// <returns>Test builder of type <see cref="IAndBadRequestTestBuilder"/>.</returns>
         IAndBadRequestTestBuilder EndingWith(string endMessage);
 
         /// <summary>
         /// Tests whether particular error message contains given message.
         /// </summary>
         /// <param name="containsMessage">Expected containing string for particular error message.</param>
-        /// <returns>HTTP bad request test builder.</returns>
+        /// <returns>Test builder of type <see cref="IAndBadRequestTestBuilder"/>.</returns>
         IAndBadRequestTestBuilder Containing(string containsMessage);
     }
 }