Add doc comments to target action components (#29982)

space-wizards · Jul 13, 2024 · b94b523 · b94b523
1 parent 1b360ac
commit b94b523
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/Content.Shared/Actions/EntityTargetActionComponent.cs b/Content.Shared/Actions/EntityTargetActionComponent.cs
@@ -4,6 +4,9 @@
 
 namespace Content.Shared.Actions;
 
+/// <summary>
+/// Used on action entities to define an action that triggers when targeting an entity.
+/// </summary>
 [RegisterComponent, NetworkedComponent]
 public sealed partial class EntityTargetActionComponent : BaseTargetActionComponent
 {
@@ -16,8 +19,15 @@ public sealed partial class EntityTargetActionComponent : BaseTargetActionCompon
     [NonSerialized]
     public EntityTargetActionEvent? Event;
 
+    /// <summary>
+    /// Determines which entities are valid targets for this action.
+    /// </summary>
+    /// <remarks>No whitelist check when null.</remarks>
     [DataField("whitelist")] public EntityWhitelist? Whitelist;
 
+    /// <summary>
+    /// Whether this action considers the user as a valid target entity when using this action.
+    /// </summary>
     [DataField("canTargetSelf")] public bool CanTargetSelf = true;
 }
 

diff --git a/Content.Shared/Actions/WorldTargetActionComponent.cs b/Content.Shared/Actions/WorldTargetActionComponent.cs
@@ -3,6 +3,9 @@
 
 namespace Content.Shared.Actions;
 
+/// <summary>
+/// Used on action entities to define an action that triggers when targeting an entity coordinate.
+/// </summary>
 [RegisterComponent, NetworkedComponent]
 public sealed partial class WorldTargetActionComponent : BaseTargetActionComponent
 {