dmdoc: Some cleanups. (#27242)

* dmdoc: Some cleanups.

* satisfy check_grep
This commit is contained in:
warriorstar-orion
2024-11-13 13:37:37 +00:00
committed by GitHub
parent f6a45ae95e
commit bfb18b48e4
24 changed files with 80 additions and 67 deletions
+1 -1
View File
@@ -44,7 +44,7 @@ GLOBAL_DATUM_INIT(welding_sparks, /mutable_appearance, mutable_appearance('icons
var/stealthy_audio = FALSE
/// Allows you to override the attack animation with an attack effect
var/attack_effect_override
/// Used in attackby() to say how something was attacked "[x] has been [z.attack_verb] by [y] with [z]"
/// Used in attackby() to say how something was attacked `"[x] has been [z.attack_verb] by [y] with [z]"`
var/list/attack_verb
/// Determines how big/small items are to fit in storage containers
var/w_class = WEIGHT_CLASS_NORMAL
+1 -1
View File
@@ -2,7 +2,7 @@
* Updates an item's appearance to mimic the appearance of another item in the dye_registry's dictionary
* what types of items (beanie, jumpsuit, shoes, etc) src is dyed into depends on the dye_key unless an
* overidden dye_key is specified. For example if our dye_key is DYE_REGISTRY_UNDER and we specify to dye to
* DYE_RED, our item's appearance would then mimic /obj/item/clothing/under/color/red; see [dye_registry.dm] for this dictionary
* DYE_RED, our item's appearance would then mimic /obj/item/clothing/under/color/red; see [code/_globalvars/lists/dye_registry.dm] for this dictionary
*
* once everything is updated, the target type path that we dyed the item into is returned
*
+2 -2
View File
@@ -120,8 +120,8 @@
/** Checks whether this stack can merge itself into another stack.
*
* Arguments:
* - [check][/obj/item/stack]: The stack to check for mergeability.
* - [inhand][boolean]: Whether or not the stack to check should act like it's in a mob's hand.
* - check: The [/obj/item/stack] to check for mergeability.
* - inhand: `TRUE` if the stack should check should act like it's in a mob's hand, `FALSE` otherwise.
*/
/obj/item/stack/proc/can_merge(obj/item/stack/check, inhand = FALSE)
// We don't only use istype here, since that will match subtypes, and stack things that shouldn't stack
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* # Police Baton
*
* Knocks down the hit mob when not on harm intent and when [/obj/item/melee/classic_baton/on] is TRUE
* Knocks down the hit mob when not on harm intent and when [/obj/item/melee/classic_baton/var/on] is `TRUE`.
*
* A non-lethal attack has a cooldown to avoid spamming
*/
+1 -1
View File
@@ -18,7 +18,7 @@
var/next_on_message
/// Cooldown until the next turned off message/sound can be activated
var/next_off_message
/// Our lighter color suffix. => [base_icon_state]-[lightercolor] => lighter-r
/// Our lighter color suffix. => `[base_icon_state]-[lightercolor]` => `lighter-r`
var/lighter_color
var/is_a_zippo = FALSE
@@ -44,7 +44,7 @@
var/door_hinge_x = -6.5
/// Amount of time it takes for the door animation to play
var/door_anim_time = 2.0 // set to 0 to make the door not animate at all
/// Whether this closet uses a door overlay at all. If FALSE, it'll switch to a system where the entire icon_state is replaced with [icon_state]_open instead.
/// Whether this closet uses a door overlay at all. If `FALSE`, it'll switch to a system where the entire icon_state is replaced with `[icon_state]_open` instead.
var/enable_door_overlay = TRUE
/// Whether this closet uses a door overlay for when it is opened
var/has_opened_overlay = TRUE