task: updates to xml comments

.gitignore

@@ -348,3 +348,8 @@ MigrationBackup/
 
 # Ionide (cross platform F# VS Code tools) working folder
 .ionide/
+
+# DocFx generated files
+/docs/**/toc.yml
+/docs/api/
+_site

src/Primitively.Abstractions/ByteAttribute.cs

@@ -3,8 +3,8 @@
 namespace Primitively;
 
 /// <summary>
-///     Make a readonly record struct that encapsulates a Unsigned 8-bit integer primitive value
-///     with a default range of: 0 to 255
+/// Make a readonly record struct that encapsulates a Unsigned 8-bit integer primitive value
+/// with a default range of: 0 to 255
 /// </summary>
 [AttributeUsage(AttributeTargets.Struct, Inherited = false, AllowMultiple = false)]
 [Conditional(Constants.ConditionalCompilationSymbol)]

src/Primitively.Abstractions/DataType.cs

@@ -1,16 +1,62 @@
 namespace Primitively;
 
+/// <summary>
+/// Data types supported by Primitively types
+/// </summary>
 public enum DataType
 {
+    /// <summary>
+    /// Represents a Primitively type that encapsulates a <see cref="Byte"/> value
+    /// </summary>
     Byte,
+
+    /// <summary>
+    /// Represents a Primitively type that encapsulates a <see cref="DateOnly"/> value
+    /// </summary>
     DateOnly,
+
+    /// <summary>
+    /// Represents a Primitively type that encapsulates a <see cref="Guid"/> value
+    /// </summary>
     Guid,
+
+    /// <summary>
+    /// Represents a Primitively type that encapsulates a <see cref="Int"/> value
+    /// </summary>
     Int,
+
+    /// <summary>
+    /// Represents a Primitively type that encapsulates a <see cref="Long"/> value
+    /// </summary>
     Long,
+
+    /// <summary>
+    /// Represents a Primitively type that encapsulates a <see cref="SByte"/> value
+    /// </summary>
     SByte,
+
+    /// <summary>
+    /// Represents a Primitively type that encapsulates a <see cref="Short"/> value
+    /// </summary>
     Short,
+
+    /// <summary>
+    /// Represents a Primitively type that encapsulates a <see cref="String"/> value
+    /// </summary>
     String,
+
+    /// <summary>
+    /// Represents a Primitively type that encapsulates a <see cref="UInt"/> value
+    /// </summary>
     UInt,
+
+    /// <summary>
+    /// Represents a Primitively type that encapsulates a <see cref="ULong"/> value
+    /// </summary>
     ULong,
+
+    /// <summary>
+    /// Represents a Primitively type that encapsulates a <see cref="UShort"/> value
+    /// </summary>
     UShort
 }

src/Primitively.Abstractions/DateOnlyAttribute.cs

@@ -3,8 +3,8 @@
 namespace Primitively;
 
 /// <summary>
-///     Make a readonly record struct that encapsulates a DateOnly primitive value
-///     with default Iso8601 format of yyyy-MM-dd
+/// Make a readonly record struct that encapsulates a DateOnly primitive value
+/// with default Iso8601 format of yyyy-MM-dd
 /// </summary>
 [AttributeUsage(AttributeTargets.Struct, Inherited = false, AllowMultiple = false)]
 [Conditional(Constants.ConditionalCompilationSymbol)]

src/Primitively.Abstractions/GuidAttribute.cs

@@ -3,7 +3,7 @@
 namespace Primitively;
 
 /// <summary>
-///     Make a readonly record struct that encapsulates a GUID primitive value
+/// Make a readonly record struct that encapsulates a GUID primitive value
 /// </summary>
 [AttributeUsage(AttributeTargets.Struct, Inherited = false, AllowMultiple = false)]
 [Conditional(Constants.ConditionalCompilationSymbol)]
@@ -20,5 +20,6 @@ public GuidAttribute(Specifier specifier)
     }
 
     public Specifier Specifier { get; }
+
     public bool ImplementIValidatableObject { get; set; }
 }

src/Primitively.Abstractions/IPrimitive.cs

@@ -1,17 +1,33 @@
 namespace Primitively;
 
+/// <summary>
+/// The interface that all source generated Primitively types implement.
+/// </summary>
 public interface IPrimitive
 {
+    /// <summary>
+    /// Flag indicating the instance has a valid value.
+    /// </summary>
+    /// <remarks>
+    /// Attempts to instantiate a Primitively type with an invalid value will result in a default instance with no value.
+    /// </remarks>
     public bool HasValue { get; }
 
+    /// <summary>
+    /// The .net type of the value that the instance encapsulates.
+    /// </summary>
     public Type ValueType { get; }
 
+    /// <summary>
+    /// The <see cref="DataType"/> enum representation of type that the instance encapsulates.
+    /// </summary>
     public DataType DataType { get; }
 
+    /// <summary>
+    /// The value encapsulated by this instance
+    /// </summary>
+    /// <remarks>
+    /// Attempts to instantiate a Primitively type with an invalid value will result in a default instance with no value.
+    /// </remarks>
     public object Value { get; }
 }
-
-public interface IPrimitive<out T> : IPrimitive
-{
-    public new T Value { get; }
-}

src/Primitively.Abstractions/IPrimitive`1.cs

@@ -0,0 +1,13 @@
+namespace Primitively;
+
+/// <summary>
+/// The generic interface that all source generated Primitively types implement
+/// </summary>
+/// <typeparam name="T">The .net type of the encapsulated value</typeparam>
+public interface IPrimitive<out T> : IPrimitive
+{
+    /// <summary>
+    /// The value of the Primitively type 
+    /// </summary>
+    public new T Value { get; }
+}

src/Primitively.Abstractions/IntAttribute.cs

@@ -3,8 +3,8 @@
 namespace Primitively;
 
 /// <summary>
-///     Make a readonly record struct that encapsulates a Signed 32-bit integer primitive value
-///     with a default range of: -2,147,483,648 to 2,147,483,647
+/// Make a readonly record struct that encapsulates a Signed 32-bit integer primitive value
+/// with a default range of: -2,147,483,648 to 2,147,483,647
 /// </summary>
 [AttributeUsage(AttributeTargets.Struct, Inherited = false, AllowMultiple = false)]
 [Conditional(Constants.ConditionalCompilationSymbol)]