Added documentation summary where missing for JSON result tests (#46)

Author: ivaylokenov

src/MyWebApi/Builders/Base/BaseTestBuilderWithActionResult.cs

@@ -92,6 +92,11 @@ protected IAndTestBuilder<TActionResult> NewAndTestBuilder()
                 this.ActionResult);
         }
 
+        /// <summary>
+        /// Returns the actual action result casted as dynamic type.
+        /// </summary>
+        /// <param name="actionResult">Result from the tested action.</param>
+        /// <returns>Object of dynamic type.</returns>
         protected dynamic GetActionResultAsDynamic(TActionResult actionResult)
         {
             return this.ActionResult.GetType().CastTo<dynamic>(this.ActionResult);

src/MyWebApi/Builders/Contracts/Json/IAndJsonSerializerSettingsTestBuilder.cs

@@ -1,7 +1,14 @@
 namespace MyWebApi.Builders.Contracts.Json
 {
+    /// <summary>
+    /// Used for testing JSON serializer settings in a JSON result with AndAlso() method.
+    /// </summary>
     public interface IAndJsonSerializerSettingsTestBuilder : IJsonSerializerSettingsTestBuilder
     {
+        /// <summary>
+        /// AndAlso method for better readability when chaining JSON serializer settings test builder.
+        /// </summary>
+        /// <returns>JSON serializer settings test builder.</returns>
         IJsonSerializerSettingsTestBuilder AndAlso();
     }
 }

src/MyWebApi/Builders/Contracts/Json/IJsonSerializerSettingsTestBuilder.cs

@@ -5,42 +5,130 @@
     using Newtonsoft.Json;
     using Newtonsoft.Json.Serialization;
 
+    /// <summary>
+    /// Used for testing JSON serializer settings in a JSON result.
+    /// </summary>
     public interface IJsonSerializerSettingsTestBuilder
     {
+        /// <summary>
+        /// Tests the Culture property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="culture">Expected Culture.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithCulture(CultureInfo culture);
 
+        /// <summary>
+        /// Tests the ContractResolver property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="contractResolver">Expected ContractResolver.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithContractResolver(IContractResolver contractResolver);
 
+        /// <summary>
+        /// Tests the ContractResolver property in a JSON serializer settings object by using generic type.
+        /// </summary>
+        /// <typeparam name="TContractResolver">Expected ContractResolver type.</typeparam>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithContractResolverOfType<TContractResolver>()
              where TContractResolver : IContractResolver;
 
+        /// <summary>
+        /// Tests the ConstructorHandling property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="constructorHandling">Expected ConstructorHandling.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithConstructorHandling(ConstructorHandling constructorHandling);
 
+        /// <summary>
+        /// Tests the DateFormatHandling property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="dateFormatHandling">Expected DateFormatHandling.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithDateFormatHandling(DateFormatHandling dateFormatHandling);
 
+        /// <summary>
+        /// Tests the DateParseHandling property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="dateParseHandling">Expected DateParseHandling.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithDateParseHandling(DateParseHandling dateParseHandling);
 
+        /// <summary>
+        /// Tests the WithDateTimeZoneHandling property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="dateTimeZoneHandling">Expected WithDateTimeZoneHandling.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithDateTimeZoneHandling(DateTimeZoneHandling dateTimeZoneHandling);
 
+        /// <summary>
+        /// Tests the DefaultValueHandling property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="defaultValueHandling">Expected DefaultValueHandling.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithDefaultValueHandling(DefaultValueHandling defaultValueHandling);
 
+        /// <summary>
+        /// Tests the Formatting property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="formatting">Expected Formatting.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithFormatting(Formatting formatting);
 
+        /// <summary>
+        /// Tests the MaxDepth property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="maxDepth">Expected max depth.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithMaxDepth(int? maxDepth);
 
+        /// <summary>
+        /// Tests the MissingMemberHandling property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="missingMemberHandling">Expected MissingMemberHandling.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithMissingMemberHandling(MissingMemberHandling missingMemberHandling);
 
+        /// <summary>
+        /// Tests the NullValueHandling property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="nullValueHandling">Expected NullValueHandling.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithNullValueHandling(NullValueHandling nullValueHandling);
 
+        /// <summary>
+        /// Tests the ObjectCreationHandling property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="objectCreationHandling">Expected ObjectCreationHandling.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithObjectCreationHandling(ObjectCreationHandling objectCreationHandling);
 
+        /// <summary>
+        /// Tests the PreserveReferencesHandling property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="preserveReferencesHandling">Expected PreserveReferencesHandling.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithPreserveReferencesHandling(
             PreserveReferencesHandling preserveReferencesHandling);
 
+        /// <summary>
+        /// Tests the ReferenceLoopHandling property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="referenceLoopHandling">Expected ReferenceLoopHandling.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithReferenceLoopHandling(ReferenceLoopHandling referenceLoopHandling);
 
+        /// <summary>
+        /// Tests the FormatterAssemblyStyle property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="typeNameAssemblyFormat">Expected FormatterAssemblyStyle.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithTypeNameAssemblyFormat(FormatterAssemblyStyle typeNameAssemblyFormat);
 
+        /// <summary>
+        /// Tests the TypeNameHandling property in a JSON serializer settings object.
+        /// </summary>
+        /// <param name="typeNameHandling">Expected TypeNameHandling.</param>
+        /// <returns>And JSON serializer settings test builder.</returns>
         IAndJsonSerializerSettingsTestBuilder WithTypeNameHandling(TypeNameHandling typeNameHandling);
     }
 }

src/MyWebApi/Builders/Contracts/Json/IJsonTestBuilder.cs

@@ -10,14 +10,37 @@
     /// </summary>
     public interface IJsonTestBuilder : IBaseResponseModelTestBuilder
     {
+        /// <summary>
+        /// Tests whether JSON result has the default UTF8 encoding.
+        /// </summary>
+        /// <returns>And JSON test builder.</returns>
         IAndJsonTestBuilder WithDefaultEncoding();
 
+        /// <summary>
+        /// Tests whether JSON result has the provided encoding.
+        /// </summary>
+        /// <param name="encoding">Expected encoding to test with.</param>
+        /// <returns>And JSON test builder.</returns>
         IAndJsonTestBuilder WithEncoding(Encoding encoding);
 
+        /// <summary>
+        /// Tests whether JSON result has the default JSON serializer settings.
+        /// </summary>
+        /// <returns>And JSON test builder.</returns>
         IAndJsonTestBuilder WithDefaulJsonSerializerSettings();
 
+        /// <summary>
+        /// Tests whether JSON result has the provided JSON serializer settings.
+        /// </summary>
+        /// <param name="jsonSerializerSettings">Expected JSON serializer settings to test with.</param>
+        /// <returns>And JSON test builder.</returns>
         IAndJsonTestBuilder WithJsonSerializerSettings(JsonSerializerSettings jsonSerializerSettings);
 
+        /// <summary>
+        /// Tests whether JSON result has JSON serializer settings by using builder.
+        /// </summary>
+        /// <param name="jsonSerializerSettingsBuilder">Builder for creating JSON serializer settings.</param>
+        /// <returns>And JSON test builder.</returns>
         IAndJsonTestBuilder WithJsonSerializerSettings(
             Action<IJsonSerializerSettingsTestBuilder> jsonSerializerSettingsBuilder);
     }