Added documentation summary for custom exceptions

ivaylokenov · ivaylokenov · commit f8486c4a3326 · 2016-05-08T23:05:13.000+03:00
diff --git a/src/MyTested.Mvc/Builders/Actions/ShouldReturn/ShouldReturnStatusCode.cs b/src/MyTested.Mvc/Builders/Actions/ShouldReturn/ShouldReturnStatusCode.cs
@@ -41,7 +41,7 @@ public IBaseTestBuilderWithActionResult<TActionResult> StatusCode(HttpStatusCode
 
         private void ThrowNewHttpStatusCodeResultAssertionException(string propertyName, string expectedValue, string actualValue)
         {
-            throw new HttpStatusCodeResultAssertionException(string.Format(
+            throw new StatusCodeResultAssertionException(string.Format(
                     "When calling {0} action in {1} expected status code result {2} {3}, but {4}.",
                     this.ActionName,
                     this.Controller.GetName(),
diff --git a/src/MyTested.Mvc/Exceptions/ActionCallAssertionException.cs b/src/MyTested.Mvc/Exceptions/ActionCallAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid action call.
+    /// <see cref="Exception"/> for invalid action call.
     /// </summary>
     public class ActionCallAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the ActionCallAssertionException class.
+        /// Initializes a new instance of the <see cref="ActionCallAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public ActionCallAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/ActionResultAssertionException.cs b/src/MyTested.Mvc/Exceptions/ActionResultAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid action return type when expecting IActionResult.
+    /// <see cref="Exception"/> for invalid action return type.
     /// </summary>
     public class ActionResultAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the ActionResultAssertionException class.
+        /// Initializes a new instance of the <see cref="ActionResultAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public ActionResultAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/AttributeAssertionException.cs b/src/MyTested.Mvc/Exceptions/AttributeAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid attributes.
+    /// <see cref="Exception"/> for invalid <see cref="Attribute"/>.
     /// </summary>
     public class AttributeAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the AttributeAssertionException class.
+        /// Initializes a new instance of the <see cref="AttributeAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public AttributeAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/AuthenticationPropertiesAssertionException.cs b/src/MyTested.Mvc/Exceptions/AuthenticationPropertiesAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid authentication properties call.
+    /// <see cref="Exception"/> for invalid <see cref="Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties"/> assertion.
     /// </summary>
     public class AuthenticationPropertiesAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the AuthenticationPropertiesAssertionException class.
+        /// Initializes a new instance of the <see cref="AuthenticationPropertiesAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public AuthenticationPropertiesAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/BadRequestResultAssertionException.cs b/src/MyTested.Mvc/Exceptions/BadRequestResultAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid bad request result.
+    /// <see cref="Exception"/> for invalid <see cref="Microsoft.AspNetCore.Mvc.BadRequestResult"/> or <see cref="Microsoft.AspNetCore.Mvc.BadRequestObjectResult"/>.
     /// </summary>
     public class BadRequestResultAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the BadRequestResultAssertionException class.
+        /// Initializes a new instance of the <see cref="BadRequestResultAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public BadRequestResultAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/ChallengeResultAssertionException.cs b/src/MyTested.Mvc/Exceptions/ChallengeResultAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid challenge result.
+    /// <see cref="Exception"/> for invalid <see cref="Microsoft.AspNetCore.Mvc.ChallengeResult"/>.
     /// </summary>
     public class ChallengeResultAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the ContentResultAssertionException class.
+        /// Initializes a new instance of the <see cref="ContentResultAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public ChallengeResultAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/ContentResultAssertionException.cs b/src/MyTested.Mvc/Exceptions/ContentResultAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid content result.
+    /// <see cref="Exception"/> for invalid <see cref="Microsoft.AspNetCore.Mvc.ContentResult"/>.
     /// </summary>
     public class ContentResultAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the ContentResultAssertionException class.
+        /// Initializes a new instance of the <see cref="ContentResultAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public ContentResultAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/CreatedResultAssertionException.cs b/src/MyTested.Mvc/Exceptions/CreatedResultAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid created result.
+    /// <see cref="Exception"/> for invalid <see cref="Microsoft.AspNetCore.Mvc.CreatedResult"/>, <see cref="Microsoft.AspNetCore.Mvc.CreatedAtActionResult"/> or <see cref="Microsoft.AspNetCore.Mvc.CreatedAtRouteResult"/>/>.
     /// </summary>
     public class CreatedResultAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the CreatedResultAssertionException class.
+        /// Initializes a new instance of the <see cref="CreatedResultAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public CreatedResultAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/DataProviderAssertionException.cs b/src/MyTested.Mvc/Exceptions/DataProviderAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid data assertion.
+    /// <see cref="Exception"/> for invalid data assertion.
     /// </summary>
     public class DataProviderAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the DataProviderAssertionException class.
+        /// Initializes a new instance of the <see cref="DataProviderAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public DataProviderAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/FileResultAssertionException.cs b/src/MyTested.Mvc/Exceptions/FileResultAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid file result.
+    /// <see cref="Exception"/> for invalid <see cref="Microsoft.AspNetCore.Mvc.FileStreamResult"/>, <see cref="Microsoft.AspNetCore.Mvc.VirtualFileResult"/>, <see cref="Microsoft.AspNetCore.Mvc.FileContentResult"/> or <see cref="Microsoft.AspNetCore.Mvc.PhysicalFileResult"/>.
     /// </summary>
     public class FileResultAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the FileResultAssertionException class.
+        /// Initializes a new instance of the <see cref="FileResultAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public FileResultAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/ForbidResultAssertionException.cs b/src/MyTested.Mvc/Exceptions/ForbidResultAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid forbid result.
+    /// <see cref="Exception"/> for invalid <see cref="Microsoft.AspNetCore.Mvc.ForbidResult"/>.
     /// </summary>
     public class ForbidResultAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the ForbidResultAssertionException class.
+        /// Initializes a new instance of the <see cref="ForbidResultAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public ForbidResultAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/HttpResponseAssertionException.cs b/src/MyTested.Mvc/Exceptions/HttpResponseAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid HTTP response.
+    /// <see cref="Exception"/> for invalid <see cref="Microsoft.AspNetCore.Http.HttpResponse"/>.
     /// </summary>
     public class HttpResponseAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the HttpResponseAssertionException class.
+        /// Initializes a new instance of the <see cref="HttpResponseAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public HttpResponseAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/HttpStatusCodeResultAssertionException.cs b/src/MyTested.Mvc/Exceptions/HttpStatusCodeResultAssertionException.cs
diff --git a/src/MyTested.Mvc/Exceptions/InvalidAssertionException.cs b/src/MyTested.Mvc/Exceptions/InvalidAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid assertion.
+    /// <see cref="Exception"/> for invalid assertion.
     /// </summary>
     public class InvalidAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the InvalidAssertionException class.
+        /// Initializes a new instance of the <see cref="InvalidAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public InvalidAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/InvalidCallAssertionException.cs b/src/MyTested.Mvc/Exceptions/InvalidCallAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid test call.
+    /// <see cref="Exception"/> for invalid test call.
     /// </summary>
     public class InvalidCallAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the InvalidCallAssertionException class.
+        /// Initializes a new instance of the <see cref="InvalidCallAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public InvalidCallAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/InvalidExceptionAssertionException.cs b/src/MyTested.Mvc/Exceptions/InvalidExceptionAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid expected exceptions.
+    /// <see cref="Exception"/> for invalid expected exceptions.
     /// </summary>
     public class InvalidExceptionAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the InvalidExceptionAssertionException class.
+        /// Initializes a new instance of the <see cref="InvalidExceptionAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public InvalidExceptionAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/InvalidHttpRequestException.cs b/src/MyTested.Mvc/Exceptions/InvalidHttpRequestException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid HTTP request.
+    /// <see cref="Exception"/> for invalid <see cref="Microsoft.AspNetCore.Http.HttpRequest"/>.
     /// </summary>
     public class InvalidHttpRequestException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the InvalidHttpRequestMessageException class.
+        /// Initializes a new instance of the <see cref="InvalidHttpRequestException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public InvalidHttpRequestException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/JsonResultAssertionException.cs b/src/MyTested.Mvc/Exceptions/JsonResultAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid JSON result.
+    /// <see cref="Exception"/> for invalid <see cref="Microsoft.AspNetCore.Mvc.JsonResult"/>.
     /// </summary>
     public class JsonResultAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the JSONResultAssertionException class.
+        /// Initializes a new instance of the <see cref="JsonResultAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public JsonResultAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/ModelErrorAssertionException.cs b/src/MyTested.Mvc/Exceptions/ModelErrorAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for model with errors.
+    /// <see cref="Exception"/> for <see cref="Microsoft.AspNetCore.Mvc.ModelBinding.ModelStateDictionary"/> errors.
     /// </summary>
     public class ModelErrorAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the ModelErrorAssertionException class.
+        /// Initializes a new instance of the <see cref="ModelErrorAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public ModelErrorAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/NotFoundResultAssertionException.cs b/src/MyTested.Mvc/Exceptions/NotFoundResultAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid not found result.
+    /// <see cref="Exception"/> for invalid <see cref="Microsoft.AspNetCore.Mvc.NotFoundResult"/> or <see cref="Microsoft.AspNetCore.Mvc.NotFoundObjectResult"/>.
     /// </summary>
     public class NotFoundResultAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the NotFoundResultAssertionException class.
+        /// Initializes a new instance of the <see cref="NotFoundResultAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public NotFoundResultAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/ObjectResultAssertionException.cs b/src/MyTested.Mvc/Exceptions/ObjectResultAssertionException.cs
@@ -3,14 +3,14 @@
     using System;
 
     /// <summary>
-    /// Exception for invalid challenge result.
+    /// <see cref="Exception"/> for invalid <see cref="Microsoft.AspNetCore.Mvc.ObjectResult"/>.
     /// </summary>
     public class ObjectResultAssertionException : Exception
     {
         /// <summary>
-        /// Initializes a new instance of the ObjectResultAssertionException class.
+        /// Initializes a new instance of the <see cref="ObjectResultAssertionException"/> class.
         /// </summary>
-        /// <param name="message">Message for System.Exception class.</param>
+        /// <param name="message">The message that describes the error.</param>
         public ObjectResultAssertionException(string message)
             : base(message)
         {
diff --git a/src/MyTested.Mvc/Exceptions/OkResultAssertionException.cs b/src/MyTested.Mvc/Exceptions/OkResultAssertionException.cs
diff --git a/src/MyTested.Mvc/Exceptions/RedirectResultAssertionException.cs b/src/MyTested.Mvc/Exceptions/RedirectResultAssertionException.cs
diff --git a/src/MyTested.Mvc/Exceptions/ResponseModelAssertionException.cs b/src/MyTested.Mvc/Exceptions/ResponseModelAssertionException.cs
diff --git a/src/MyTested.Mvc/Exceptions/RouteAssertionException.cs b/src/MyTested.Mvc/Exceptions/RouteAssertionException.cs
diff --git a/src/MyTested.Mvc/Exceptions/StatusCodeResultAssertionException.cs b/src/MyTested.Mvc/Exceptions/StatusCodeResultAssertionException.cs
diff --git a/src/MyTested.Mvc/Exceptions/UnresolvedDependenciesException.cs b/src/MyTested.Mvc/Exceptions/UnresolvedDependenciesException.cs
diff --git a/src/MyTested.Mvc/Exceptions/ViewResultAssertionException.cs b/src/MyTested.Mvc/Exceptions/ViewResultAssertionException.cs
diff --git a/test/MyTested.Mvc.Test/BuildersTests/ActionsTests/ShouldReturnTests/ShouldReturnHttpStatusCodeTests.cs b/test/MyTested.Mvc.Test/BuildersTests/ActionsTests/ShouldReturnTests/ShouldReturnHttpStatusCodeTests.cs

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public IBaseTestBuilderWithActionResult<TActionResult> StatusCode(HttpStatusCode`
`41`	`41`
`42`	`42`	`private void ThrowNewHttpStatusCodeResultAssertionException(string propertyName, string expectedValue, string actualValue)`
`43`	`43`	`{`
`44`		`- throw new HttpStatusCodeResultAssertionException(string.Format(`
	`44`	`+ throw new StatusCodeResultAssertionException(string.Format(`
`45`	`45`	`"When calling {0} action in {1} expected status code result {2} {3}, but {4}.",`
`46`	`46`	`this.ActionName,`
`47`	`47`	`this.Controller.GetName(),`