Add XML documentation comments to public and internal types

src/All.Mvc/Extensions/HtmlHelperExtensions.cs

@@ -1,11 +1,8 @@
 // Wrap: Functional Monads for .NET
 // Copyright (c) bfren - licensed under https://mit.bfren.dev/2019
 
 using Microsoft.AspNetCore.Mvc.Rendering;
 
 namespace Wrap.Mvc;
 
-/// <summary>
-/// <see cref="IHtmlHelper"/> extension methods
-/// </summary>
 public static partial class HtmlHelperExtensions { }

src/All.Mvc/Extensions/ListExtensions.cs

@@ -1,11 +1,8 @@
 // Wrap: Functional Monads for .NET
 // Copyright (c) bfren - licensed under https://mit.bfren.dev/2019
 
 using System.Collections.Generic;
 
 namespace Wrap.Mvc;
 
-/// <summary>
-/// <see cref="IList{IModelBinderProvider}"/> extension methods
-/// </summary>
 public static partial class ListExtensions { }

src/All.Mvc/WrapModelBinder.cs

@@ -11,6 +11,9 @@
 
 namespace Wrap.Mvc;
 
+/// <summary>
+/// Model binder for monad types in ASP.NET Core MVC.
+/// </summary>
 internal static class WrapModelBinderHelpers
 {
 	internal static JsonSerializerOptions Options { get; private set; }

src/All/Constants.cs

@@ -3,6 +3,9 @@
 
 namespace Wrap;
 
+/// <summary>
+/// Internal constants used throughout the Wrap library for error messages and validation.
+/// </summary>
 internal static class C
 {
 	internal const string NoneFailureMessage = "Maybe<{Type}> was 'None'.";
@@ -11,6 +14,9 @@ internal static class C
 
 	internal const string TestFalseMessage = "Test returned false.";
 
+	/// <summary>
+	/// Contains error messages for single element retrieval operations.
+	/// </summary>
 	internal static class GetSingle
 	{
 		internal const string EmptyList =

src/All/Extensions/DictionaryExtensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Extensions;
 
-/// <summary>
-/// Extension methods for <see cref="System.Collections.Generic.IDictionary{TKey, TValue}"/> objects.
-/// </summary>
 public static partial class DictionaryExtensions { }

src/All/Extensions/EitherExtensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Extensions;
 
-/// <summary>
-/// Extension methods for <see cref="Either{TLeft, TRight}"/> objects.
-/// </summary>
 public static partial class EitherExtensions { }

src/All/Extensions/EnumerableExtensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Extensions;
 
-/// <summary>
-/// Extension methods for <see cref="System.Collections.Generic.IEnumerable{T}"/> objects.
-/// </summary>
 public static partial class EnumerableExtensions { }

src/All/Extensions/GuidExtensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Extensions;
 
-/// <summary>
-/// Extension methods for <see cref="System.Guid"/> objects.
-/// </summary>
 public static partial class GuidExtensions { }

src/All/Extensions/Int32Extensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Extensions;
 
-/// <summary>
-/// Extension methods for <see cref="int"/> objects.
-/// </summary>
 public static partial class Int32Extensions { }

src/All/Extensions/Int64Extensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Extensions;
 
-/// <summary>
-/// Extension methods for <see cref="long"/> objects.
-/// </summary>
 public static partial class Int64Extensions { }

src/All/Extensions/MaybeExtensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Extensions;
 
-/// <summary>
-/// Extension methods for <see cref="Maybe{T}"/> objects.
-/// </summary>
 public static partial class MaybeExtensions { }

src/All/Extensions/MonadExtensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Extensions;
 
-/// <summary>
-/// Extension methods for <see cref="Monad{T}"/> objects.
-/// </summary>
 public static partial class MonadExtensions { }

src/All/Extensions/ResultExtensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Extensions;
 
-/// <summary>
-/// Extension methods for <see cref="Result{T}"/> objects.
-/// </summary>
 public static partial class ResultExtensions { }

src/All/Extensions/UInt32Extensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Extensions;
 
-/// <summary>
-/// Extension methods for <see cref="uint"/> objects.
-/// </summary>
 public static partial class UInt32Extensions { }

src/All/Extensions/UInt64Extensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Extensions;
 
-/// <summary>
-/// Extension methods for <see cref="ulong"/> objects.
-/// </summary>
 public static partial class UInt64Extensions { }

src/All/Extensions/UnsafeExtensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Extensions;
 
-/// <summary>
-/// Extension methods for <see cref="Unsafe{TEither, TLeft, TRight}"/> objects.
-/// </summary>
 public static partial class UnsafeExtensions { }

src/All/Json/Extensions/ListExtensions.cs

@@ -1,11 +1,8 @@
 // Wrap: Functional Monads for .NET
 // Copyright (c) bfren - licensed under https://mit.bfren.dev/2019
 
 using System.Collections.Generic;
 
 namespace Wrap.Json;
 
-/// <summary>
-/// <see cref="IList{JsonConverter}"/> extension methods.
-/// </summary>
 public static partial class ListExtensions { }

src/All/Linq/MaybeToMaybeExtensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Linq;
 
-/// <summary>
-/// Extension methods enabling LINQ syntax for <see cref="Maybe{T}"/> objects.
-/// </summary>
 public static partial class MaybeToMaybeExtensions { }

src/All/Linq/MaybeToResultExtensions.cs

@@ -3,8 +3,4 @@
 
 namespace Wrap.Linq;
 
-/// <summary>
-/// Extension methods enabling LINQ syntax for converting <see cref="Maybe{T}"/>
-/// objects to <see cref="Result{T}"/> objects.
-/// </summary>
 public static partial class MaybeToResultExtensions { }

src/All/Linq/ResultExtensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Linq;
 
-/// <summary>
-/// Extension methods enabling LINQ syntax for <see cref="Result{T}"/>.
-/// </summary>
 public static partial class ResultExtensions { }

src/Common/Extensions/ObjectExtensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Extensions;
 
-/// <summary>
-/// Extension methods for all objects.
-/// </summary>
 public static partial class ObjectExtensions { }

src/Common/F.cs

@@ -6,10 +6,7 @@
 
 namespace Wrap;
 
-/// <summary>
-/// Pure functions for interacting with Monad types.
-/// </summary>
 public static partial class F
 {
 	/// <summary>
 	/// Default culture (en-GB) - used when working with strings.

src/Either/E.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap;
 
-/// <summary>
-/// Pure functions for interacting with <see cref="Either{TLeft, TRight}"/> types.
-/// </summary>
 public static partial class E { }

src/Maybe.Testing/MaybeExtensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Testing;
 
-/// <summary>
-/// Extension methods for <see cref="Maybe{T}"/> objects.
-/// </summary>
 public static partial class MaybeExtensions { }

src/Maybe/M.cs

@@ -5,9 +5,6 @@
 
 namespace Wrap;
 
-/// <summary>
-/// Pure functions for interacting with <see cref="Maybe{T}"/> types.
-/// </summary>
 public static partial class M
 {
 	/// <summary>

src/Maybe/Maybe.cs

@@ -7,10 +7,6 @@
 
 namespace Wrap;
 
-/// <summary>
-/// Maybe monad.
-/// </summary>
-/// <typeparam name="T">Some value type.</typeparam>
 public abstract partial record class Maybe<T> : IEither<Maybe<T>, None, T>, IEquatable<Maybe<T>>
 {
 	/// <summary>

src/Result.Testing/FailureValueExtensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Testing;
 
-/// <summary>
-/// Extension methods for <see cref="FailureValue"/> objects.
-/// </summary>
 public static partial class FailureValueExtensions { }

src/Result.Testing/ResultExtensions.cs

@@ -3,7 +3,4 @@
 
 namespace Wrap.Testing;
 
-/// <summary>
-/// Extension methods for <see cref="Result{T}"/> objects.
-/// </summary>
 public static partial class ResultExtensions { }

src/Result/Failure.Equatable.cs

@@ -3,6 +3,9 @@
 
 namespace Wrap;
 
+/// <summary>
+/// Represents failure.
+/// </summary>
 public readonly partial struct Failure
 {
 	/// <inheritdoc/>

src/Result/R.cs

@@ -6,9 +6,6 @@
 
 namespace Wrap;
 
-/// <summary>
-/// Pure functions for interacting with <see cref="Result{TOk}"/> objects.
-/// </summary>
 public static partial class R
 {
 	/// <summary>

src/Result/Result.FailureImpl.cs

@@ -8,7 +8,7 @@ namespace Wrap;
 public abstract partial record class Result<T>
 {
 	/// <summary>
-	/// Internal implementation of <see cref="Result{T}"/> to 
+	/// Internal implementation of <see cref="Result{T}"/> representing a failure state.
 	/// </summary>
 	internal sealed record class FailureImpl : Result<T>, ILeft<FailureValue, T>
 	{

src/Result/Result.cs

@@ -7,11 +7,7 @@
 
 namespace Wrap;
 
-/// <summary>
-/// Result monad.
-/// </summary>
-/// <typeparam name="T">Ok value type.</typeparam>
 public abstract partial record class Result<T> : IEither<Result<T>, FailureValue, T>, IEquatable<Result<T>>
 {
 	/// <summary>
 	/// Returns true if this object is a <see cref="Failure"/>.