Browse Source

Added small description on RequiredColumnAttribute

Kenric Nugteren 8 months ago
parent
commit
b45f951c2b
1 changed files with 3 additions and 0 deletions
  1. 3 0
      InABox.Core/Entity.cs

+ 3 - 0
InABox.Core/Entity.cs

@@ -202,6 +202,9 @@ namespace InABox.Core
     /// If it is part of an <see cref="IEntityLink"/> (or <see cref="IEnclosedEntity"/>), then it is only required
     /// if the <see cref="IEntityLink"/> property on the parent class also has <see cref="RequiredColumnAttribute"/>.
     /// </summary>
+    /// <remarks>
+    /// In general, this should be used in one of two places - either if the property is required by the store for the entity, or if it is used by the <see cref="BaseObject.DoPropertyChanged(string, object?, object?)"/> function.
+    /// </remarks>
     public class RequiredColumnAttribute : Attribute { }
 
     public abstract class Entity : BaseObject, IEntity