Update a wide variety of comments

CHANGELOG.md

@@ -95,7 +95,13 @@
 
 
 ## Code Optimization
-- **September 15, 2024:** 1 File Changed
+- **September 30, 2024:** 32 Files Changed
+    - Add/edit a lot of function comments and move a couple of functions (within the same file)
+    - Change several magic numbers to the correct constants and add constants for wLineSeparation
+
+<br/>
+
+- **[September 15, 2024](https://github.com/Sha0den/poketcg_v2/commit/fc428d659332548d2c5f5a856518db642db3e29b):** 1 File Changed
     - Some more comments and minor optimizations in home/substatus.asm
 
 <br/>

src/constants/text_constants.asm

@@ -50,3 +50,7 @@ DEF TX_CTRL_END   EQU $10
 ; wFontWidth constants
 DEF FULL_WIDTH EQU $0
 DEF HALF_WIDTH EQU $1 ; non-0
+
+; wLineSeparation constants
+DEF DOUBLE_SPACED EQU 0
+DEF SINGLE_SPACED EQU 1 ; non-0

src/engine/bank20.asm

@@ -1360,7 +1360,7 @@ SpriteNullAnimationFrame:
 ;Func_80c64:
 ;	ld a, [wLineSeparation]
 ;	push af
-;	ld a, $01 ; no line separator
+;	ld a, SINGLE_SPACED
 ;	ld [wLineSeparation], a
 ;	; load opponent's name
 ;	ld a, [wOpponentName]

src/engine/challenge_machine.asm

@@ -15,7 +15,7 @@ ChallengeMachine_Reset:
 ; if a challenge is already in progress, then resume the challenge.
 ; otherwise, start a new challenge with 5 rounds.
 ChallengeMachine_Start::
-	xor a ; text is double-spaced
+	xor a ; DOUBLE_SPACED
 	ld [wLineSeparation], a
 	call LoadConsolePaletteData
 	call ChallengeMachine_Initialize

src/engine/copy_card_name.asm

@@ -2,7 +2,7 @@
 ; preserves bc and de
 ; input:
 ;	a = length in number of tiles (the resulting string will be padded with spaces to match it)
-;	wLoadedCard1 = contains a card_data_struct
+;	[wLoadedCard1] = all of the card's data (card_data_struct)
 _CopyCardNameAndLevel::
 	push bc
 	push de