diff --git a/src/All.Mvc/Extensions/HtmlHelperExtensions.cs b/src/All.Mvc/Extensions/HtmlHelperExtensions.cs index 5052409d..c4d6f0e6 100644 --- a/src/All.Mvc/Extensions/HtmlHelperExtensions.cs +++ b/src/All.Mvc/Extensions/HtmlHelperExtensions.cs @@ -5,7 +5,4 @@ namespace Wrap.Mvc; -/// -/// extension methods -/// public static partial class HtmlHelperExtensions { } diff --git a/src/All.Mvc/Extensions/ListExtensions.cs b/src/All.Mvc/Extensions/ListExtensions.cs index c9e3d94e..e93c968a 100644 --- a/src/All.Mvc/Extensions/ListExtensions.cs +++ b/src/All.Mvc/Extensions/ListExtensions.cs @@ -5,7 +5,4 @@ namespace Wrap.Mvc; -/// -/// extension methods -/// public static partial class ListExtensions { } diff --git a/src/All.Mvc/WrapModelBinder.cs b/src/All.Mvc/WrapModelBinder.cs index f6921d0f..8b1ee76f 100644 --- a/src/All.Mvc/WrapModelBinder.cs +++ b/src/All.Mvc/WrapModelBinder.cs @@ -11,6 +11,9 @@ namespace Wrap.Mvc; +/// +/// Model binder for monad types in ASP.NET Core MVC. +/// internal static class WrapModelBinderHelpers { internal static JsonSerializerOptions Options { get; private set; } diff --git a/src/All/Constants.cs b/src/All/Constants.cs index 151ee790..a89ee99b 100644 --- a/src/All/Constants.cs +++ b/src/All/Constants.cs @@ -3,6 +3,9 @@ namespace Wrap; +/// +/// Internal constants used throughout the Wrap library for error messages and validation. +/// 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."; + /// + /// Contains error messages for single element retrieval operations. + /// internal static class GetSingle { internal const string EmptyList = diff --git a/src/All/Extensions/DictionaryExtensions.cs b/src/All/Extensions/DictionaryExtensions.cs index 4f9e33da..1d1e93b1 100644 --- a/src/All/Extensions/DictionaryExtensions.cs +++ b/src/All/Extensions/DictionaryExtensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Extensions; -/// -/// Extension methods for objects. -/// public static partial class DictionaryExtensions { } diff --git a/src/All/Extensions/EitherExtensions.cs b/src/All/Extensions/EitherExtensions.cs index cf231f4c..e2068d39 100644 --- a/src/All/Extensions/EitherExtensions.cs +++ b/src/All/Extensions/EitherExtensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Extensions; -/// -/// Extension methods for objects. -/// public static partial class EitherExtensions { } diff --git a/src/All/Extensions/EnumerableExtensions.cs b/src/All/Extensions/EnumerableExtensions.cs index ff865ebf..698a26bc 100644 --- a/src/All/Extensions/EnumerableExtensions.cs +++ b/src/All/Extensions/EnumerableExtensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Extensions; -/// -/// Extension methods for objects. -/// public static partial class EnumerableExtensions { } diff --git a/src/All/Extensions/GuidExtensions.cs b/src/All/Extensions/GuidExtensions.cs index 1d4f191f..17b1ffeb 100644 --- a/src/All/Extensions/GuidExtensions.cs +++ b/src/All/Extensions/GuidExtensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Extensions; -/// -/// Extension methods for objects. -/// public static partial class GuidExtensions { } diff --git a/src/All/Extensions/Int32Extensions.cs b/src/All/Extensions/Int32Extensions.cs index a94173e8..03bb4c5a 100644 --- a/src/All/Extensions/Int32Extensions.cs +++ b/src/All/Extensions/Int32Extensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Extensions; -/// -/// Extension methods for objects. -/// public static partial class Int32Extensions { } diff --git a/src/All/Extensions/Int64Extensions.cs b/src/All/Extensions/Int64Extensions.cs index 57b22db2..0d4b6265 100644 --- a/src/All/Extensions/Int64Extensions.cs +++ b/src/All/Extensions/Int64Extensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Extensions; -/// -/// Extension methods for objects. -/// public static partial class Int64Extensions { } diff --git a/src/All/Extensions/MaybeExtensions.cs b/src/All/Extensions/MaybeExtensions.cs index 19023675..79bf436d 100644 --- a/src/All/Extensions/MaybeExtensions.cs +++ b/src/All/Extensions/MaybeExtensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Extensions; -/// -/// Extension methods for objects. -/// public static partial class MaybeExtensions { } diff --git a/src/All/Extensions/MonadExtensions.cs b/src/All/Extensions/MonadExtensions.cs index 6ea8fd0c..c137807e 100644 --- a/src/All/Extensions/MonadExtensions.cs +++ b/src/All/Extensions/MonadExtensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Extensions; -/// -/// Extension methods for objects. -/// public static partial class MonadExtensions { } diff --git a/src/All/Extensions/ResultExtensions.cs b/src/All/Extensions/ResultExtensions.cs index d29d9759..ae1c9acb 100644 --- a/src/All/Extensions/ResultExtensions.cs +++ b/src/All/Extensions/ResultExtensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Extensions; -/// -/// Extension methods for objects. -/// public static partial class ResultExtensions { } diff --git a/src/All/Extensions/UInt32Extensions.cs b/src/All/Extensions/UInt32Extensions.cs index 5dc55e89..2df9bd60 100644 --- a/src/All/Extensions/UInt32Extensions.cs +++ b/src/All/Extensions/UInt32Extensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Extensions; -/// -/// Extension methods for objects. -/// public static partial class UInt32Extensions { } diff --git a/src/All/Extensions/UInt64Extensions.cs b/src/All/Extensions/UInt64Extensions.cs index 5090f225..4c4af324 100644 --- a/src/All/Extensions/UInt64Extensions.cs +++ b/src/All/Extensions/UInt64Extensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Extensions; -/// -/// Extension methods for objects. -/// public static partial class UInt64Extensions { } diff --git a/src/All/Extensions/UnsafeExtensions.cs b/src/All/Extensions/UnsafeExtensions.cs index 7fd9f0c4..dfc5f4b3 100644 --- a/src/All/Extensions/UnsafeExtensions.cs +++ b/src/All/Extensions/UnsafeExtensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Extensions; -/// -/// Extension methods for objects. -/// public static partial class UnsafeExtensions { } diff --git a/src/All/Json/Extensions/ListExtensions.cs b/src/All/Json/Extensions/ListExtensions.cs index afdcd54c..50e81d48 100644 --- a/src/All/Json/Extensions/ListExtensions.cs +++ b/src/All/Json/Extensions/ListExtensions.cs @@ -5,7 +5,4 @@ namespace Wrap.Json; -/// -/// extension methods. -/// public static partial class ListExtensions { } diff --git a/src/All/Linq/MaybeToMaybeExtensions.cs b/src/All/Linq/MaybeToMaybeExtensions.cs index 5267a6b4..abafd3ad 100644 --- a/src/All/Linq/MaybeToMaybeExtensions.cs +++ b/src/All/Linq/MaybeToMaybeExtensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Linq; -/// -/// Extension methods enabling LINQ syntax for objects. -/// public static partial class MaybeToMaybeExtensions { } diff --git a/src/All/Linq/MaybeToResultExtensions.cs b/src/All/Linq/MaybeToResultExtensions.cs index d1ddbb6b..fe999994 100644 --- a/src/All/Linq/MaybeToResultExtensions.cs +++ b/src/All/Linq/MaybeToResultExtensions.cs @@ -3,8 +3,4 @@ namespace Wrap.Linq; -/// -/// Extension methods enabling LINQ syntax for converting -/// objects to objects. -/// public static partial class MaybeToResultExtensions { } diff --git a/src/All/Linq/ResultExtensions.cs b/src/All/Linq/ResultExtensions.cs index b52c6cf7..9b76e6d8 100644 --- a/src/All/Linq/ResultExtensions.cs +++ b/src/All/Linq/ResultExtensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Linq; -/// -/// Extension methods enabling LINQ syntax for . -/// public static partial class ResultExtensions { } diff --git a/src/Common/Extensions/ObjectExtensions.cs b/src/Common/Extensions/ObjectExtensions.cs index 11fa642b..38fa89c3 100644 --- a/src/Common/Extensions/ObjectExtensions.cs +++ b/src/Common/Extensions/ObjectExtensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Extensions; -/// -/// Extension methods for all objects. -/// public static partial class ObjectExtensions { } diff --git a/src/Common/F.cs b/src/Common/F.cs index 8e78f698..67b53ea9 100644 --- a/src/Common/F.cs +++ b/src/Common/F.cs @@ -6,9 +6,6 @@ namespace Wrap; -/// -/// Pure functions for interacting with Monad types. -/// public static partial class F { /// diff --git a/src/Either/E.cs b/src/Either/E.cs index 3692203c..b66fb0a5 100644 --- a/src/Either/E.cs +++ b/src/Either/E.cs @@ -3,7 +3,4 @@ namespace Wrap; -/// -/// Pure functions for interacting with types. -/// public static partial class E { } diff --git a/src/Maybe.Testing/MaybeExtensions.cs b/src/Maybe.Testing/MaybeExtensions.cs index 153739bf..af6f2b6e 100644 --- a/src/Maybe.Testing/MaybeExtensions.cs +++ b/src/Maybe.Testing/MaybeExtensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Testing; -/// -/// Extension methods for objects. -/// public static partial class MaybeExtensions { } diff --git a/src/Maybe/M.cs b/src/Maybe/M.cs index 2c453a61..45ac51e7 100644 --- a/src/Maybe/M.cs +++ b/src/Maybe/M.cs @@ -5,9 +5,6 @@ namespace Wrap; -/// -/// Pure functions for interacting with types. -/// public static partial class M { /// diff --git a/src/Maybe/Maybe.cs b/src/Maybe/Maybe.cs index f5a979d3..862d7b73 100644 --- a/src/Maybe/Maybe.cs +++ b/src/Maybe/Maybe.cs @@ -7,10 +7,6 @@ namespace Wrap; -/// -/// Maybe monad. -/// -/// Some value type. public abstract partial record class Maybe : IEither, None, T>, IEquatable> { /// diff --git a/src/Result.Testing/FailureValueExtensions.cs b/src/Result.Testing/FailureValueExtensions.cs index 0d64a41d..7c971894 100644 --- a/src/Result.Testing/FailureValueExtensions.cs +++ b/src/Result.Testing/FailureValueExtensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Testing; -/// -/// Extension methods for objects. -/// public static partial class FailureValueExtensions { } diff --git a/src/Result.Testing/ResultExtensions.cs b/src/Result.Testing/ResultExtensions.cs index e183c6ca..2b56c04d 100644 --- a/src/Result.Testing/ResultExtensions.cs +++ b/src/Result.Testing/ResultExtensions.cs @@ -3,7 +3,4 @@ namespace Wrap.Testing; -/// -/// Extension methods for objects. -/// public static partial class ResultExtensions { } diff --git a/src/Result/Failure.Equatable.cs b/src/Result/Failure.Equatable.cs index 5d29a239..f5eef1d5 100644 --- a/src/Result/Failure.Equatable.cs +++ b/src/Result/Failure.Equatable.cs @@ -3,6 +3,9 @@ namespace Wrap; +/// +/// Represents failure. +/// public readonly partial struct Failure { /// diff --git a/src/Result/R.cs b/src/Result/R.cs index 67554ce9..bae5cf79 100644 --- a/src/Result/R.cs +++ b/src/Result/R.cs @@ -6,9 +6,6 @@ namespace Wrap; -/// -/// Pure functions for interacting with objects. -/// public static partial class R { /// diff --git a/src/Result/Result.FailureImpl.cs b/src/Result/Result.FailureImpl.cs index f2140043..fae50209 100644 --- a/src/Result/Result.FailureImpl.cs +++ b/src/Result/Result.FailureImpl.cs @@ -8,7 +8,7 @@ namespace Wrap; public abstract partial record class Result { /// - /// Internal implementation of to + /// Internal implementation of representing a failure state. /// internal sealed record class FailureImpl : Result, ILeft { diff --git a/src/Result/Result.cs b/src/Result/Result.cs index d1c35801..53fd83a3 100644 --- a/src/Result/Result.cs +++ b/src/Result/Result.cs @@ -7,10 +7,6 @@ namespace Wrap; -/// -/// Result monad. -/// -/// Ok value type. public abstract partial record class Result : IEither, FailureValue, T>, IEquatable> { ///