Documented Entity.

Author: Iain Scott

src/Winton.DomainModelling.Abstractions/Entity.cs

@@ -2,26 +2,59 @@
 
 namespace Winton.DomainModelling
 {
+    /// <inheritdoc />
+    /// <summary>
+    ///     A base class to implement entity types, which are defined by their identity rather than their attributes.
+    /// </summary>
+    /// <typeparam name="TEntityId">The ID type for the entity type.</typeparam>
     public abstract class Entity<TEntityId> : IEquatable<Entity<TEntityId>>
         where TEntityId : IEquatable<TEntityId>
     {
+        /// <summary>
+        ///     Initializes a new instance of the <see cref="Entity{TEntityId}" /> class.
+        /// </summary>
+        /// <param name="id">The ID for the entity.</param>
         protected Entity(TEntityId id)
         {
             Id = id;
         }
 
+        /// <summary>
+        ///     Gets the ID for the entity.
+        /// </summary>
         public TEntityId Id { get; }
 
+        /// <summary>
+        ///     Indicates whether two entities are equal.
+        /// </summary>
+        /// <param name="left">The first entity.</param>
+        /// <param name="right">The second entity.</param>
+        /// <returns><see langword="true" /> if the entities have the same ID; otherwise, <see langword="false" />.</returns>
         public static bool operator ==(Entity<TEntityId> left, Entity<TEntityId> right)
         {
             return Equals(left, right);
         }
 
+        /// <summary>
+        ///     Indicates whether two entities are unequal.
+        /// </summary>
+        /// <param name="left">The first entity.</param>
+        /// <param name="right">The second entity.</param>
+        /// <returns><see langword="true" /> if the entities have different IDs; otherwise, <see langword="false" />.</returns>
         public static bool operator !=(Entity<TEntityId> left, Entity<TEntityId> right)
         {
             return !Equals(left, right);
         }
 
+        /// <inheritdoc />
+        /// <summary>
+        ///     Indicates whether the current entity is equal to another entity.
+        /// </summary>
+        /// <param name="other">An entity to compare with this entity.</param>
+        /// <returns>
+        ///     <see langword="true" /> if the current entity has the same ID as the <paramref name="other" /> entity;
+        ///     otherwise, <see langword="false" />.
+        /// </returns>
         public bool Equals(Entity<TEntityId> other)
         {
             if (other is null)
@@ -42,11 +75,23 @@ public bool Equals(Entity<TEntityId> other)
             return !Id.Equals(default(TEntityId)) && !other.Id.Equals(default(TEntityId)) && Id.Equals(other.Id);
         }
 
+        /// <summary>
+        ///     Determines whether the specified object is equal to the current object.
+        /// </summary>
+        /// <param name="obj">The object to compare with the current object.</param>
+        /// <returns>
+        ///     <see langword="true" /> if the specified object is equal to the current object; otherwise,
+        ///     <see langword="false" />.
+        /// </returns>
         public override bool Equals(object obj)
         {
             return Equals(obj as Entity<TEntityId>);
         }
 
+        /// <summary>
+        ///     Serves as the default hash function.
+        /// </summary>
+        /// <returns>A hash code for the current object.</returns>
         public override int GetHashCode()
         {
             return Id.GetHashCode();

src/Winton.DomainModelling.Abstractions/Winton.DomainModelling.Abstractions.csproj

@@ -5,7 +5,7 @@
     <Company>Winton</Company>
     <Copyright>Copyright 2018 Winton</Copyright>
     <Description>Provides common abstractions for domain modelling.</Description>
-    <GenerateDocumentationFile>False</GenerateDocumentationFile>
+    <GenerateDocumentationFile>True</GenerateDocumentationFile>
     <NoWarn>$(NoWarn);SA0001;SA1101;SA1309;SA1413;SA1633;SA1652</NoWarn>
     <PackageId>Winton.DomainModelling.Abstractions</PackageId>
     <PackageRequireLicenseAcceptance>False</PackageRequireLicenseAcceptance>