From: lzk <124214523+lzk228@users.noreply.github.com>
Date: Fri, 5 Jul 2024 13:01:39 +0000 (+0200)
Subject: Add summary comments for ElectrifiedComponent fields (#29733)
X-Git-Url: https://git.smokeofanarchy.ru/gitweb.cgi?a=commitdiff_plain;h=b0ae7d57255117752e633df8687763921a0369c0;p=space-station-14.git

Add summary comments for ElectrifiedComponent fields (#29733)

add summaries for ElectrifiedComponent
---

diff --git a/Content.Server/Electrocution/Components/ElectrifiedComponent.cs b/Content.Server/Electrocution/Components/ElectrifiedComponent.cs
index 4ef07a0cca..5755e98091 100644
--- a/Content.Server/Electrocution/Components/ElectrifiedComponent.cs
+++ b/Content.Server/Electrocution/Components/ElectrifiedComponent.cs
@@ -11,33 +11,63 @@ public sealed partial class ElectrifiedComponent : Component
     [DataField("enabled")]
     public bool Enabled = true;
 
+    /// <summary>
+    /// Should player get damage on collide
+    /// </summary>
     [DataField("onBump")]
     public bool OnBump = true;
 
+    /// <summary>
+    /// Should player get damage on attack
+    /// </summary>
     [DataField("onAttacked")]
     public bool OnAttacked = true;
 
+    /// <summary>
+    /// When true - disables power if a window is present in the same tile
+    /// </summary>
     [DataField("noWindowInTile")]
     public bool NoWindowInTile = false;
 
+    /// <summary>
+    /// Should player get damage on interact with empty hand
+    /// </summary>
     [DataField("onHandInteract")]
     public bool OnHandInteract = true;
 
+    /// <summary>
+    /// Should player get damage on interact while holding an object in their hand
+    /// </summary>
     [DataField("onInteractUsing")]
     public bool OnInteractUsing = true;
 
+    /// <summary>
+    /// Indicates if the entity requires power to function
+    /// </summary>
     [DataField("requirePower")]
     public bool RequirePower = true;
 
+    /// <summary>
+    /// Indicates if the entity uses APC power
+    /// </summary>
     [DataField("usesApcPower")]
     public bool UsesApcPower = false;
 
+    /// <summary>
+    /// Identifier for the high voltage node.
+    /// </summary>
     [DataField("highVoltageNode")]
     public string? HighVoltageNode;
 
+    /// <summary>
+    /// Identifier for the medium voltage node.
+    /// </summary>
     [DataField("mediumVoltageNode")]
     public string? MediumVoltageNode;
 
+    /// <summary>
+    /// Identifier for the low voltage node.
+    /// </summary>
     [DataField("lowVoltageNode")]
     public string? LowVoltageNode;
 
@@ -69,7 +99,7 @@ public sealed partial class ElectrifiedComponent : Component
     public float ShockDamage = 7.5f;
 
     /// <summary>
-    ///     Shock time, in seconds.
+    /// Shock time, in seconds.
     /// </summary>
     [DataField("shockTime")]
     public float ShockTime = 8f;