move all EOL comments on typepath names to dmdoc (#23928)

* move all EOL comments on typepath names to dmdoc * Apply suggestions from code review Co-authored-by: Luc <89928798+lewcc@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: S34N <12197162+S34NW@users.noreply.github.com> --------- Co-authored-by: Luc <89928798+lewcc@users.noreply.github.com> Co-authored-by: S34N <12197162+S34NW@users.noreply.github.com>
2026-07-19 11:05:03 +01:00 · 2024-03-01 15:05:49 -05:00
parent 25996e232a
commit 0667f20681
211 changed files with 955 additions and 478 deletions
@@ -83,19 +83,22 @@ GLOBAL_LIST_EMPTY(body_accessory_by_species)
 	return ..()

 //Tajaran
-/datum/body_accessory/tail/wingler_tail // Jay wingler fluff tail
+/// Jay wingler fluff tail
+/datum/body_accessory/tail/wingler_tail
 	name = "Striped Tail"
 	icon_state = "winglertail"
 	animated_icon_state = "winglertail_a"
 	allowed_species = list("Tajaran")

-/datum/body_accessory/tail/tiny //Pretty ambiguous as to what species it belongs to, tail could've been injured or docked.
+/// Pretty ambiguous as to what species it belongs to, tail could've been injured or docked.
+/datum/body_accessory/tail/tiny
 	name = "Tiny Tail"
 	icon_state = "tiny"
 	animated_icon_state = "tiny_a"
 	allowed_species = list("Vulpkanin", "Tajaran")

-/datum/body_accessory/tail/short //Same as above.
+/// Same as above.
+/datum/body_accessory/tail/short
 	name = "Short Tail"
 	icon_state = "short"
 	animated_icon_state = "short_a"
@@ -131,7 +131,8 @@
 			H.set_nutrition(min(H.nutrition + 30, NUTRITION_LEVEL_FULL))
 	return TRUE

-/datum/species/diona/pod //Same name and everything; we want the same limitations on them; we just want their regeneration to kick in at all times and them to have special factions
+/// Same name and everything; we want the same limitations on them; we just want their regeneration to kick in at all times and them to have special factions
+/datum/species/diona/pod
 	name = "Diomorph" //Seperate name needed else can't select diona period
 	species_traits = list(NO_HAIR, NOT_SELECTABLE)
 	pod = TRUE
@@ -1,6 +1,7 @@
 //Simple borg hand.
 //Limited use.
-/obj/item/gripper_engineering // This isn't a drone item, also in engineering cyborg kits
+/// This isn't a drone item, also in engineering cyborg kits
+/obj/item/gripper_engineering
 	name = "magnetic gripper"
 	desc = "A simple grasping tool for synthetic assets."
 	icon = 'icons/obj/device.dmi'
@@ -1,4 +1,5 @@
-/mob/living/simple_animal/bot/secbot/griefsky //This bot is powerful. If you managed to get 4 eswords somehow, you deserve this horror. Emag him for best results.
+/// This bot is powerful. If you managed to get 4 eswords somehow, you deserve this horror. Emag him for best results.
+/mob/living/simple_animal/bot/secbot/griefsky
 	name = "\improper General Griefsky"
 	desc = "Is that a secbot with four eswords in its arms...?"
 	icon_state = "griefsky0"
@@ -18,7 +19,8 @@
 	var/spam_flag = 0
 	var/frustration_number = 15

-/mob/living/simple_animal/bot/secbot/griefsky/toy  //A toy version of general griefsky!
+/// A toy version of general griefsky!
+/mob/living/simple_animal/bot/secbot/griefsky/toy
 	name = "Genewul Giftskee"
 	desc = "An adorable looking secbot with four toy swords taped to its arms"
 	spin_icon = "griefskyj-c"
@@ -162,7 +162,8 @@
 	playstyle_string = "<b>You are a Juggernaut. Though slow, your shell can withstand extreme punishment, \
 						create shield walls, rip apart enemies and walls.</b>"

-/mob/living/simple_animal/hostile/construct/armoured/hostile //actually hostile, will move around, hit things
+/// actually hostile, will move around, hit things
+/mob/living/simple_animal/hostile/construct/armoured/hostile
 	AIStatus = AI_ON
 	environment_smash = 1 //only token destruction, don't smash the cult wall NO STOP

@@ -195,10 +196,12 @@
 	retreat_distance = 2 //AI wraiths will move in and out of combat
 	playstyle_string = "<b>You are a Wraith. Though relatively fragile, you are fast, deadly, and even able to phase through walls.</b>"

-/mob/living/simple_animal/hostile/construct/wraith/hostile //actually hostile, will move around, hit things
+/// actually hostile, will move around, hit things
+/mob/living/simple_animal/hostile/construct/wraith/hostile
 	AIStatus = AI_ON

-/mob/living/simple_animal/hostile/construct/wraith/hostile/bubblegum //Used in bubblegum summoning. Needs MOB_SIZE_LARGE so crushers don't suffer
+/// Used in bubblegum summoning. Needs MOB_SIZE_LARGE so crushers don't suffer
+/mob/living/simple_animal/hostile/construct/wraith/hostile/bubblegum
 	mob_size =	MOB_SIZE_LARGE

 /////////////////////////////Artificer/////////////////////////
@@ -276,7 +279,8 @@
 	retreat_distance = initial(retreat_distance)
 	minimum_distance = initial(minimum_distance)

-/mob/living/simple_animal/hostile/construct/builder/hostile //actually hostile, will move around, hit things, heal other constructs
+/// actually hostile, will move around, hit things, heal other constructs
+/mob/living/simple_animal/hostile/construct/builder/hostile
 	AIStatus = AI_ON
 	environment_smash = ENVIRONMENT_SMASH_STRUCTURES //only token destruction, don't smash the cult wall NO STOP

@@ -306,7 +310,8 @@
 	var/energy = 0
 	var/max_energy = 1000

-/mob/living/simple_animal/hostile/construct/behemoth/hostile //actually hostile, will move around, hit things
+/// actually hostile, will move around, hit things
+/mob/living/simple_animal/hostile/construct/behemoth/hostile
 	AIStatus = AI_ON
 	environment_smash = 1 //only token destruction, don't smash the cult wall NO STOP

@@ -340,7 +345,8 @@
 	return TRUE


-/mob/living/simple_animal/hostile/construct/harvester/hostile //actually hostile, will move around, hit things
+/// actually hostile, will move around, hit things
+/mob/living/simple_animal/hostile/construct/harvester/hostile
 	AIStatus = AI_ON
 	environment_smash = 1 //only token destruction, don't smash the cult wall NO STOP

@@ -647,7 +647,8 @@
 	// Puppies do not have a head or back equipment slot.
 	return "<br><B>Collar:</B> <A href='?src=[UID()];[pcollar ? "remove_inv=collar'>[pcollar]" : "add_inv=collar'>Nothing"]</A>"

-/mob/living/simple_animal/pet/dog/corgi/puppy/void		//Tribute to the corgis born in nullspace
+/// Tribute to the corgis born in nullspace
+/mob/living/simple_animal/pet/dog/corgi/puppy/void
 	name = "\improper void puppy"
 	real_name = "voidy"
 	desc = "A corgi puppy that has been infused with deep space energy. It's staring back..."
@@ -784,7 +784,8 @@ Difficulty: Hard
 	duration = 20


-/obj/item/projectile/energy/tesla_bolt //Leaving here for adminbus / so vetus still uses it.
+/// Leaving here for adminbus / so vetus still uses it.
+/obj/item/projectile/energy/tesla_bolt
 	name = "shock bolt"
 	icon_state = "purple_laser"
 	impact_effect_type = /obj/effect/temp_visual/impact_effect/purple_laser
@@ -810,7 +811,8 @@ Difficulty: Hard
 	var/turf/target_turf = get_turf(A)
 	loc = target_turf

-/obj/effect/temp_visual/dragon_swoop/bubblegum/ancient_robot //this is the worst path I have ever made
+/// this is the worst path I have ever made
+/obj/effect/temp_visual/dragon_swoop/bubblegum/ancient_robot
 	icon_state = "target"

 /obj/effect/temp_visual/dragon_swoop/bubblegum/ancient_robot/Initialize(mapload, target)
@@ -110,7 +110,8 @@ Difficulty: Medium
 		shoot_ka()
 	transform_weapon()

-/obj/item/melee/energy/cleaving_saw/miner //nerfed saw because it is very murdery
+/// nerfed saw because it is very murdery
+/obj/item/melee/energy/cleaving_saw/miner
 	force = 6
 	force_on = 10

@@ -577,7 +577,8 @@ Difficulty: Hard
 		var/turf/simulated/mineral/M = loc
 		M.gets_drilled(caster)

-/obj/effect/temp_visual/hierophant/wall //smoothing and pooling were not friends, but pooling is dead.
+/// smoothing and pooling were not friends, but pooling is dead.
+/obj/effect/temp_visual/hierophant/wall
 	name = "vortex wall"
 	icon = 'icons/turf/walls/hierophant_wall_temp.dmi'
 	icon_state = "hierophant_wall_temp-0"
@@ -612,7 +613,8 @@ Difficulty: Hard
 		return TRUE
 	return FALSE

-/obj/effect/temp_visual/hierophant/chaser //a hierophant's chaser. follows target around, moving and producing a blast every speed deciseconds.
+/// a hierophant's chaser. follows target around, moving and producing a blast every speed deciseconds.
+/obj/effect/temp_visual/hierophant/chaser
 	duration = 98
 	var/mob/living/target //what it's following
 	var/turf/targetturf //what turf the target is actually on
@@ -1,6 +1,7 @@


-/obj/structure/alien/resin/flower_bud_enemy //inheriting basic attack/damage stuff from alien structures
+/// inheriting basic attack/damage stuff from alien structures
+/obj/structure/alien/resin/flower_bud_enemy
 	name = "flower bud"
 	desc = "A large pulsating plant..."
 	icon = 'icons/effects/spacevines.dmi'
@@ -89,7 +89,8 @@
 			new next_stage(get_turf(src))
 			qdel(src)	//hide the body

-/mob/living/simple_animal/hostile/winter/santa/stage_1		//stage 1: slow melee
+/// stage 1: slow melee
+/mob/living/simple_animal/hostile/winter/santa/stage_1
 	maxHealth = 150
 	health = 150
 	desc = "GET THE FAT MAN!"
@@ -99,7 +100,8 @@
 	melee_damage_lower = 10
 	melee_damage_upper = 20

-/mob/living/simple_animal/hostile/winter/santa/stage_2		//stage 2: slow ranged
+/// stage 2: slow ranged
+/mob/living/simple_animal/hostile/winter/santa/stage_2
 	desc = "GET THE FAT MAN AGAIN!"
 	next_stage = /mob/living/simple_animal/hostile/winter/santa/stage_3
 	death_message = "<span class='danger'>YOU'VE BEEN VERY NAUGHTY! PREPARE TO DIE!</span>"
@@ -110,7 +112,8 @@
 	retreat_distance = 5
 	minimum_distance = 5

-/mob/living/simple_animal/hostile/winter/santa/stage_3		//stage 3: fast rapidfire ranged
+/// stage 3: fast rapidfire ranged
+/mob/living/simple_animal/hostile/winter/santa/stage_3
 	desc = "WHY WON'T HE DIE ALREADY!?"
 	next_stage = /mob/living/simple_animal/hostile/winter/santa/stage_4
 	death_message = "<span class='danger'>FACE MY FINAL FORM AND KNOW DESPAIR!</span>"
@@ -123,7 +126,8 @@
 	retreat_distance = 3
 	minimum_distance = 3

-/mob/living/simple_animal/hostile/winter/santa/stage_4		//stage 4: fast spinebreaker
+/// stage 4: fast spinebreaker
+/mob/living/simple_animal/hostile/winter/santa/stage_4
 	name = "Final Form Santa"
 	desc = "WHAT THE HELL IS HE!?! WHY WON'T HE STAY DEAD!?!"
 	maxHealth = 300		//YOU FACE JARAX- I MEAN SANTA!
@@ -8,7 +8,8 @@
 	species_allowed = list("Unathi", "Tajaran", "Vulpkanin")
 	icon_state = "tiger"

-/datum/sprite_accessory/body_markings/tattoo // Tattoos applied post-round startup with tattoo guns in item_defines.dm
+/// Tattoos applied post-round startup with tattoo guns in item_defines.dm
+/datum/sprite_accessory/body_markings/tattoo
 	species_allowed = list("Human", "Unathi", "Vulpkanin", "Tajaran", "Skrell")
 	icon_state = "none"

@@ -17,7 +18,8 @@
 	icon_state = "campbell"
 	species_allowed = null

-/datum/sprite_accessory/body_markings/tattoo/tiger_body // Yep, this is repeated. To be fixed later
+/// Yep, this is repeated. To be fixed later
+/datum/sprite_accessory/body_markings/tattoo/tiger_body
 	name = "Tiger-stripe Tattoo"
 	species_allowed = list("Human", "Unathi", "Vulpkanin", "Tajaran", "Skrell")
 	icon_state = "tiger"
@@ -762,7 +762,8 @@
 	icon_state = "father"
 	species_allowed = list("Human", "Slime People", "Unathi", "Tajaran", "Vulpkanin")

-/datum/sprite_accessory/hair/bun4 // Due to a vulp hairstyle called bun
+/// Due to a vulp hairstyle called bun
+/datum/sprite_accessory/hair/bun4
 	name = "Bun 4"
 	icon_state = "bun4"
 	species_allowed = list("Human", "Slime People", "Unathi", "Tajaran", "Vulpkanin")
@@ -854,7 +855,8 @@


 ///Fluff HairStyles//
-/datum/sprite_accessory/hair/fluff/pinapple_fluff_hair //Pineapple Salad hair fluff its for a slime..has to go under human
+/// Pineapple Salad hair fluff its for a slime..has to go under human
+/datum/sprite_accessory/hair/fluff/pinapple_fluff_hair
 	name = "Sasook Hair"
 	icon_state = "psalad_fluff_hair"
 	species_allowed = list("Slime People")
@@ -1,7 +1,8 @@
 /datum/sprite_accessory/body_markings/tail/shared
 	icon = 'icons/mob/sprite_accessories/shared/shared_tail_markings.dmi'

-/datum/sprite_accessory/body_markings/tail/shared/short_tip //Species-ambiguous, generic short tail.
+/// Species-ambiguous, generic short tail.
+/datum/sprite_accessory/body_markings/tail/shared/short_tip
 	name = "Short Tail Tip"
 	species_allowed = list("Vulpkanin", "Tajaran")
 	tails_allowed = list("Short Tail")
@@ -155,7 +155,8 @@
 	secondary_theme = "fest"
 	no_sec_colour = 1

-/datum/sprite_accessory/hair/fluff/zeke_fluff_tentacle //Zeke Fluff hair
+/// Zeke Fluff hair
+/datum/sprite_accessory/hair/fluff/zeke_fluff_tentacle
 	icon = 'icons/mob/sprite_accessories/skrell/skrell_hair.dmi'
 	name = "Zekes Tentacles"
 	icon_state = "zeke_fluff_hair"
@@ -31,14 +31,17 @@
 	name = "Tajaran Muzzle and Inner Ears"
 	icon_state = "muzinears"

-/datum/sprite_accessory/body_markings/head/tajara/muzzle_alt_taj //Companion marking for Tajaran Belly 2.
+/// Companion marking for Tajaran Belly 2.
+/datum/sprite_accessory/body_markings/head/tajara/muzzle_alt_taj
 	name = "Tajaran Muzzle 2"
 	icon_state = "muzzle2"

-/datum/sprite_accessory/body_markings/head/tajara/points_taj //Companion marking for Tajaran Points.
+/// Companion marking for Tajaran Points.
+/datum/sprite_accessory/body_markings/head/tajara/points_taj
 	name = "Tajaran Points Head"
 	icon_state = "points"

-/datum/sprite_accessory/body_markings/head/tajara/patchy_taj //Companion marking for Tajaran Patches.
+/// Companion marking for Tajaran Patches.
+/datum/sprite_accessory/body_markings/head/tajara/patchy_taj
 	name = "Tajaran Patches Head"
 	icon_state = "patch"
@@ -2,6 +2,7 @@
 	icon = 'icons/mob/sprite_accessories/tajaran/tajaran_tail_markings.dmi'
 	species_allowed = list("Tajaran")

-/datum/sprite_accessory/body_markings/tail/tajara/taj_wingler_stripes //Tiger stripes.
+/// Tiger stripes.
+/datum/sprite_accessory/body_markings/tail/tajara/taj_wingler_stripes
 	name = "Tajaran Tail Stripes"
 	icon_state = "default_wingler"
@@ -3,7 +3,8 @@
 	species_allowed = list("Unathi")
 	glasses_over = 1

-/datum/sprite_accessory/hair/braid_hip_una // Future coder: Change the typepath under unathi. This is a legacy of my accessories splitting PR where typepath change is avoided at all cost
+// Future coder: Change the typepath under unathi. This is a legacy of my accessories splitting PR where typepath change is avoided at all cost
+/datum/sprite_accessory/hair/braid_hip_una
 	icon = 'icons/mob/sprite_accessories/unathi/unathi_hair.dmi'
 	name = "Unathi Hippie Braid"
 	icon_state = "hipbraid"
@@ -20,16 +20,19 @@
 	icon_state = "lowersnout"
 	heads_allowed = list("All")

-/datum/sprite_accessory/body_markings/head/unathi/banded_una //Companion marking for Unathi Banded.
+/// Companion marking for Unathi Banded.
+/datum/sprite_accessory/body_markings/head/unathi/banded_una
 	name = "Unathi Banded Head"
 	icon_state = "bandedface"
 	heads_allowed = list("All")

-/datum/sprite_accessory/body_markings/head/unathi/snout_narrow_una //Companion marking for Unathi Narrow Belly.
+/// Companion marking for Unathi Narrow Belly.
+/datum/sprite_accessory/body_markings/head/unathi/snout_narrow_una
 	name = "Unathi Snout 2"
 	icon_state = "facenarrow"

-/datum/sprite_accessory/body_markings/head/unathi/points_una //Companion marking for Unathi Points.
+/// Companion marking for Unathi Points.
+/datum/sprite_accessory/body_markings/head/unathi/points_una
 	name = "Unathi Points Head"
 	icon_state = "pointsface"
 	heads_allowed = list("All")
@@ -45,6 +48,7 @@
 	name = "Unathi Sharp Snout"
 	icon_state = "snoutsharp"

-/datum/sprite_accessory/body_markings/head/unathi/sharp/snout_narrow_una_sharp //Companion marking for Unathi Narrow Belly.
+/// Companion marking for Unathi Narrow Belly.
+/datum/sprite_accessory/body_markings/head/unathi/sharp/snout_narrow_una_sharp
 	name = "Unathi Sharp Snout 2"
 	icon_state = "facesharp"
@@ -18,18 +18,22 @@
 	name = "Vulpkanin Tiger Head and Face"
 	icon_state = "tiger_face"

-/datum/sprite_accessory/body_markings/head/vulpkanin/muzzle_vulp //Companion marking for Vulpkanin Belly Alt..
+/// Companion marking for Vulpkanin Belly Alt..
+/datum/sprite_accessory/body_markings/head/vulpkanin/muzzle_vulp
 	name = "Vulpkanin Muzzle"
 	icon_state = "muzzle"

-/datum/sprite_accessory/body_markings/head/vulpkanin/muzzle_ears_vulp //Companion marking for Vulpkanin Belly Alt..
+/// Companion marking for Vulpkanin Belly Alt..
+/datum/sprite_accessory/body_markings/head/vulpkanin/muzzle_ears_vulp
 	name = "Vulpkanin Muzzle and Ears"
 	icon_state = "muzzle_ear"

-/datum/sprite_accessory/body_markings/head/vulpkanin/points_fade_vulp //Companion marking for Vulpkanin Points Fade.
+/// Companion marking for Vulpkanin Points Fade.
+/datum/sprite_accessory/body_markings/head/vulpkanin/points_fade_vulp
 	name = "Vulpkanin Points Head"
 	icon_state = "points_fade"

-/datum/sprite_accessory/body_markings/head/vulpkanin/points_sharp_vulp //Companion marking for Vulpkanin Points Sharp.
+/// Companion marking for Vulpkanin Points Sharp.
+/datum/sprite_accessory/body_markings/head/vulpkanin/points_sharp_vulp
 	name = "Vulpkanin Points Head 2"
 	icon_state = "points_sharp"