浏览代码

Added comment for SecurityAttribute

Kenric Nugteren 11 月之前
父节点
当前提交
0fe1a4b2b5
共有 1 个文件被更改,包括 7 次插入0 次删除
  1. 7 0
      InABox.Core/Editors/Utils/SecurityAttribute.cs

+ 7 - 0
InABox.Core/Editors/Utils/SecurityAttribute.cs

@@ -3,6 +3,13 @@ using System.Linq;
 
 namespace InABox.Core
 {
+    /// <summary>
+    /// Causes a property to update its editable status based on <see cref="SecurityDescriptor"/>. If the current user does not have the security token,
+    /// then the property's visiblity is restricted to at most <see cref="Editable"/>.
+    /// </summary>
+    /// <remarks>
+    /// <see cref="Editable"/> defaults to <see cref="Editable.Hidden"/>.
+    /// </remarks>
     [AttributeUsage(AttributeTargets.Property, AllowMultiple = true)]
     public class SecurityAttribute : Attribute
     {