From ed40b7d99afaef8f864559fdd29fa22d64e2c015 Mon Sep 17 00:00:00 2001
From: deltanedas <39013340+deltanedas@users.noreply.github.com>
Date: Mon, 17 Mar 2025 23:26:12 +0000
Subject: [PATCH] add missing surgery step documentation (#3261)

Co-authored-by: deltanedas <@deltanedas:kde.org>
---
 .../Conditions/SurgeryOrganSlotConditionComponent.cs        | 3 +++
 .../Surgery/Steps/SurgeryAddOrganSlotStepComponent.cs       | 6 ++++++
 2 files changed, 9 insertions(+)

diff --git a/Content.Shared/_Shitmed/Surgery/Conditions/SurgeryOrganSlotConditionComponent.cs b/Content.Shared/_Shitmed/Surgery/Conditions/SurgeryOrganSlotConditionComponent.cs
index 67ebe0546f..a88606768b 100644
--- a/Content.Shared/_Shitmed/Surgery/Conditions/SurgeryOrganSlotConditionComponent.cs
+++ b/Content.Shared/_Shitmed/Surgery/Conditions/SurgeryOrganSlotConditionComponent.cs
@@ -2,6 +2,9 @@ using Robust.Shared.GameStates;
 
 namespace Content.Shared._Shitmed.Medical.Surgery.Conditions;
 
+/// <summary>
+/// Requires that an organ slot does (not) exist on the target part for a surgery to be possible.
+/// </summary>
 [RegisterComponent, NetworkedComponent]
 public sealed partial class SurgeryOrganSlotConditionComponent : Component
 {
diff --git a/Content.Shared/_Shitmed/Surgery/Steps/SurgeryAddOrganSlotStepComponent.cs b/Content.Shared/_Shitmed/Surgery/Steps/SurgeryAddOrganSlotStepComponent.cs
index b77c886a1a..38d6a7cede 100644
--- a/Content.Shared/_Shitmed/Surgery/Steps/SurgeryAddOrganSlotStepComponent.cs
+++ b/Content.Shared/_Shitmed/Surgery/Steps/SurgeryAddOrganSlotStepComponent.cs
@@ -1,6 +1,12 @@
+using Content.Shared._Shitmed.Medical.Surgery.Conditions;
 using Robust.Shared.GameStates;
 
 namespace Content.Shared._Shitmed.Medical.Surgery.Steps;
 
+/// <summary>
+/// Adds an organ slot the body part when the step is complete.
+/// Requires <see cref="SurgeryOrganSlotConditionComponent"/> on
+/// the surgery entity in order to specify the organ slot.
+/// </summary>
 [RegisterComponent, NetworkedComponent]
 public sealed partial class SurgeryAddOrganSlotStepComponent : Component;