From 9bebd68f19d3d1270121cca56b9afee271d01ffb Mon Sep 17 00:00:00 2001
From: AnonymousRandomPerson <chenghanngan.us@gmail.com>
Date: Tue, 5 Sep 2023 23:40:04 -0400
Subject: [PATCH] Synced docs for decomped functions

---
 include/dungeon_random.h      |  7 +++++++
 include/main_pack.h           | 38 +++++++++++++++++++++++++++++++++--
 include/overlay_29_022E0354.h |  3 +++
 include/overlay_29_022E1A1C.h |  3 +++
 include/overlay_29_022E32E8.h |  3 +++
 include/overlay_29_022E37B8.h |  3 +++
 include/overlay_29_022E95F4.h |  3 +++
 include/overlay_29_022EC608.h |  3 +++
 include/overlay_29_022ECDC0.h |  3 +++
 include/overlay_29_022EE348.h |  3 +++
 include/overlay_29_022EF7A0.h |  3 +++
 include/overlay_29_022F0590.h |  3 +++
 include/overlay_29_022F528C.h |  3 +++
 include/overlay_29_022F62A8.h |  3 +++
 include/overlay_29_022F7364.h |  3 +++
 include/overlay_29_022FC99C.h |  3 +++
 include/overlay_29_022FED98.h |  3 +++
 include/overlay_29_023000E4.h |  3 +++
 include/overlay_29_02302A38.h |  3 +++
 include/overlay_29_023047B8.h |  3 +++
 include/overlay_29_0230558C.h |  3 +++
 include/overlay_29_02305C04.h |  3 +++
 include/overlay_29_02307EF8.h |  3 +++
 include/overlay_29_0230827C.h |  3 +++
 include/overlay_29_02308FBC.h |  3 +++
 include/overlay_29_0230E8F0.h |  3 +++
 include/overlay_29_0230F008.h |  3 +++
 include/overlay_29_02311010.h |  3 +++
 include/overlay_29_023118B4.h |  3 +++
 include/overlay_29_02315118.h |  3 +++
 include/overlay_29_02318D34.h |  3 +++
 include/overlay_29_02318E4C.h |  3 +++
 include/overlay_29_02319F8C.h |  3 +++
 include/overlay_29_0231B194.h |  3 +++
 include/overlay_29_0231CBC8.h |  3 +++
 include/overlay_29_0231EDD8.h |  3 +++
 include/overlay_29_0231F570.h |  3 +++
 include/overlay_29_0231FBFC.h |  3 +++
 include/overlay_29_0232017C.h |  3 +++
 include/overlay_29_02320764.h |  3 +++
 include/overlay_29_02321438.h |  3 +++
 include/overlay_29_02325620.h |  3 +++
 include/overlay_29_0232800C.h |  3 +++
 include/overlay_29_0232A3D8.h |  3 +++
 include/overlay_29_0232C500.h |  3 +++
 include/overlay_29_0232E250.h |  3 +++
 include/overlay_29_0232E840.h |  3 +++
 include/overlay_29_02333FAC.h |  3 +++
 include/overlay_29_023350D8.h |  3 +++
 include/overlay_29_02337CA8.h |  3 +++
 include/overlay_29_02344AF8.h |  3 +++
 include/overlay_29_02345698.h |  3 +++
 include/overlay_29_02347BA4.h |  3 +++
 include/overlay_29_0234987C.h |  3 +++
 include/overlay_29_0234DDD0.h |  3 +++
 include/overlay_29_0234EC14.h |  3 +++
 56 files changed, 205 insertions(+), 2 deletions(-)

diff --git a/include/dungeon_random.h b/include/dungeon_random.h
index 007f6c27..0e08d0bd 100644
--- a/include/dungeon_random.h
+++ b/include/dungeon_random.h
@@ -1,7 +1,14 @@
 #ifndef PMDSKY_DUNGEON_RANDOM_H
 #define PMDSKY_DUNGEON_RANDOM_H
 
+// Returns the result of a possibly biased coin flip (a Bernoulli random variable) with some success probability p, using the dungeon PRNG.
+// percentChance: success percentage (100*p)
+// return: true with probability p, false with probability (1-p)
 u8 DungeonRandOutcome__022EAB20(s32 percentChance);
+
+// Returns the result of a possibly biased coin flip (a Bernoulli random variable) with some success probability p, using the dungeon PRNG.
+// percentChance: success percentage (100*p)
+// return: true with probability p, false with probability (1-p)
 u8 DungeonRandOutcome__022EAB50(s32 percentChance);
 
 #endif //PMDSKY_DUNGEON_RANDOM_H
diff --git a/include/main_pack.h b/include/main_pack.h
index aef5f17f..4fa1d155 100644
--- a/include/main_pack.h
+++ b/include/main_pack.h
@@ -3,12 +3,46 @@
 
 #include <files/pack.h>
 
+// Open the 6 files at PACK_FILE_PATHS_TABLE into PACK_FILE_OPENED. Called during game initialisation.
 void OpenAllPackFiles(void);
+
+// Call GetFileLengthInPack after looking up the global Pack archive by its number
+// pack_id: pack file number
+// file_index: file number
+// return: size of the file in bytes from the Pack Table of Content
 u32 GetFileLengthInPackWithPackNb(enum pack_file_id pack_id, u32 file_index);
+
+// Call LoadFileInPack after looking up the global Pack archive by its identifier
+// pack_id: pack file identifier
+// file_index: file index
+// output_buffer: [output] target buffer
+// return: number of read bytes (identical to the length of the pack from the Table of Content)
 u32 LoadFileInPackWithPackId(enum pack_file_id pack_id, u32 file_index, void* output_buffer);
+
+// Allocate a file and load a file from the pack archive inside.
+// The data pointed by the pointer in the output need to be freed once is not needed anymore.
+// pack_id: pack file identifier
+// file_index: file index
+// output: [output] result struct (will contain length and pointer)
+// malloc_flags: allocation flags
 void AllocAndLoadFileInPack(enum pack_file_id pack_id, u32 file_index, struct pack_alloc_and_load_result *output, u32 malloc_flags);
-void OpenPackFile(struct pack_file_opened *pack_file,char *file_path);
+
+// Open a Pack file, to be read later. Initialise the output structure.
+// pack_file: [output] pack file struct
+// file_path: file name
+void OpenPackFile(struct pack_file_opened *pack_file, char *file_path);
+
+// Get the length of a file entry from a Pack archive
+// pack_file: pack file struct
+// file_index: file index
+// return: size of the file in bytes from the Pack Table of Content
 u32 GetFileLengthInPack(struct pack_file_opened* pack_file, u32 file_index);
-u32 LoadFileInPack(struct pack_file_opened *pack_file,void *output_buffer,u32 file_index);
+
+// Load the indexed file from the Pack archive, itself loaded from the ROM.
+// pack_file: pack file struct
+// output_buffer: [output] target buffer
+// file_index: file index
+// return: number of read bytes (identical to the length of the pack from the Table of Content)
+u32 LoadFileInPack(struct pack_file_opened *pack_file, void *output_buffer,u32 file_index);
 
 #endif //PMDSKY_MAIN_PACK_H
diff --git a/include/overlay_29_022E0354.h b/include/overlay_29_022E0354.h
index 4ee09003..2ee992b8 100644
--- a/include/overlay_29_022E0354.h
+++ b/include/overlay_29_022E0354.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__022E0354(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_022E0354_H
diff --git a/include/overlay_29_022E1A1C.h b/include/overlay_29_022E1A1C.h
index a65c9c21..c9bee943 100644
--- a/include/overlay_29_022E1A1C.h
+++ b/include/overlay_29_022E1A1C.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__022E1A1C(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_022E1A1C_H
diff --git a/include/overlay_29_022E32E8.h b/include/overlay_29_022E32E8.h
index a19a81e6..fd2e2e81 100644
--- a/include/overlay_29_022E32E8.h
+++ b/include/overlay_29_022E32E8.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__022E32E8(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_022E32E8_H
diff --git a/include/overlay_29_022E37B8.h b/include/overlay_29_022E37B8.h
index edcc10cf..6d57ba6d 100644
--- a/include/overlay_29_022E37B8.h
+++ b/include/overlay_29_022E37B8.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__022E37B8(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_022E37B8_H
diff --git a/include/overlay_29_022E95F4.h b/include/overlay_29_022E95F4.h
index 21820aaf..3e8d1db3 100644
--- a/include/overlay_29_022E95F4.h
+++ b/include/overlay_29_022E95F4.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__022E95F4(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_022E95F4_H
diff --git a/include/overlay_29_022EC608.h b/include/overlay_29_022EC608.h
index 571ced24..eac19c7a 100644
--- a/include/overlay_29_022EC608.h
+++ b/include/overlay_29_022EC608.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__022EC608(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_022EC608_H
diff --git a/include/overlay_29_022ECDC0.h b/include/overlay_29_022ECDC0.h
index 95be16b0..816a0661 100644
--- a/include/overlay_29_022ECDC0.h
+++ b/include/overlay_29_022ECDC0.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__022ECDC0(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_022ECDC0_H
diff --git a/include/overlay_29_022EE348.h b/include/overlay_29_022EE348.h
index c8bfd6d5..724c9890 100644
--- a/include/overlay_29_022EE348.h
+++ b/include/overlay_29_022EE348.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__022EE348(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_022EE348_H
diff --git a/include/overlay_29_022EF7A0.h b/include/overlay_29_022EF7A0.h
index c9cfedc7..a450628b 100644
--- a/include/overlay_29_022EF7A0.h
+++ b/include/overlay_29_022EF7A0.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__022EF7A0(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_022EF7A0_H
diff --git a/include/overlay_29_022F0590.h b/include/overlay_29_022F0590.h
index 602c2d4a..c369b8c1 100644
--- a/include/overlay_29_022F0590.h
+++ b/include/overlay_29_022F0590.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__022F0590(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_022F0590_H
diff --git a/include/overlay_29_022F528C.h b/include/overlay_29_022F528C.h
index 08da5704..70e911a3 100644
--- a/include/overlay_29_022F528C.h
+++ b/include/overlay_29_022F528C.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__022F528C(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_022F528C_H
diff --git a/include/overlay_29_022F62A8.h b/include/overlay_29_022F62A8.h
index 12a413da..48d23a1a 100644
--- a/include/overlay_29_022F62A8.h
+++ b/include/overlay_29_022F62A8.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__022F62A8(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_022F62A8_H
diff --git a/include/overlay_29_022F7364.h b/include/overlay_29_022F7364.h
index 04bcd792..48319172 100644
--- a/include/overlay_29_022F7364.h
+++ b/include/overlay_29_022F7364.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__022F7364(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_022F7364_H
diff --git a/include/overlay_29_022FC99C.h b/include/overlay_29_022FC99C.h
index 4c379b5e..ae7e8a05 100644
--- a/include/overlay_29_022FC99C.h
+++ b/include/overlay_29_022FC99C.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__022FC99C(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_022FC99C_H
diff --git a/include/overlay_29_022FED98.h b/include/overlay_29_022FED98.h
index 1ca227d7..b4927a1e 100644
--- a/include/overlay_29_022FED98.h
+++ b/include/overlay_29_022FED98.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__022FED98(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_022FED98_H
diff --git a/include/overlay_29_023000E4.h b/include/overlay_29_023000E4.h
index 89befc0e..f25b63bf 100644
--- a/include/overlay_29_023000E4.h
+++ b/include/overlay_29_023000E4.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__023000E4(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_023000E4_H
diff --git a/include/overlay_29_02302A38.h b/include/overlay_29_02302A38.h
index d9c23026..8b0b0dde 100644
--- a/include/overlay_29_02302A38.h
+++ b/include/overlay_29_02302A38.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02302A38(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02302A38_H
diff --git a/include/overlay_29_023047B8.h b/include/overlay_29_023047B8.h
index 4499f37b..4117f323 100644
--- a/include/overlay_29_023047B8.h
+++ b/include/overlay_29_023047B8.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__023047B8(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_023047B8_H
diff --git a/include/overlay_29_0230558C.h b/include/overlay_29_0230558C.h
index 9bae3d1a..eea126e3 100644
--- a/include/overlay_29_0230558C.h
+++ b/include/overlay_29_0230558C.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__0230558C(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0230558C_H
diff --git a/include/overlay_29_02305C04.h b/include/overlay_29_02305C04.h
index 5a4cfdef..55cd3609 100644
--- a/include/overlay_29_02305C04.h
+++ b/include/overlay_29_02305C04.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02305C04(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02305C04_H
diff --git a/include/overlay_29_02307EF8.h b/include/overlay_29_02307EF8.h
index 2a3714dc..31b303fb 100644
--- a/include/overlay_29_02307EF8.h
+++ b/include/overlay_29_02307EF8.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02307EF8(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02307EF8_H
diff --git a/include/overlay_29_0230827C.h b/include/overlay_29_0230827C.h
index eef5dd08..f0e29038 100644
--- a/include/overlay_29_0230827C.h
+++ b/include/overlay_29_0230827C.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__0230827C(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0230827C_H
diff --git a/include/overlay_29_02308FBC.h b/include/overlay_29_02308FBC.h
index 71c3d1b5..eec8abf1 100644
--- a/include/overlay_29_02308FBC.h
+++ b/include/overlay_29_02308FBC.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02308FBC(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02308FBC_H
diff --git a/include/overlay_29_0230E8F0.h b/include/overlay_29_0230E8F0.h
index 8dfda95e..ae6b4e16 100644
--- a/include/overlay_29_0230E8F0.h
+++ b/include/overlay_29_0230E8F0.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__0230E8F0(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0230E8F0_H
diff --git a/include/overlay_29_0230F008.h b/include/overlay_29_0230F008.h
index 37a59cc3..636dc0be 100644
--- a/include/overlay_29_0230F008.h
+++ b/include/overlay_29_0230F008.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__0230F008(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0230F008_H
diff --git a/include/overlay_29_02311010.h b/include/overlay_29_02311010.h
index 824183f9..fff19a3b 100644
--- a/include/overlay_29_02311010.h
+++ b/include/overlay_29_02311010.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02311010(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02311010_H
diff --git a/include/overlay_29_023118B4.h b/include/overlay_29_023118B4.h
index ef2fbaab..f4b28469 100644
--- a/include/overlay_29_023118B4.h
+++ b/include/overlay_29_023118B4.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__023118B4(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_023118B4_H
diff --git a/include/overlay_29_02315118.h b/include/overlay_29_02315118.h
index a1e746b6..3879b3b7 100644
--- a/include/overlay_29_02315118.h
+++ b/include/overlay_29_02315118.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02315118(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02315118_H
diff --git a/include/overlay_29_02318D34.h b/include/overlay_29_02318D34.h
index a07b4752..53fbca6e 100644
--- a/include/overlay_29_02318D34.h
+++ b/include/overlay_29_02318D34.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02318D34(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02318D34_H
diff --git a/include/overlay_29_02318E4C.h b/include/overlay_29_02318E4C.h
index b704c4d6..93efa632 100644
--- a/include/overlay_29_02318E4C.h
+++ b/include/overlay_29_02318E4C.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02318E4C(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02318E4C_H
diff --git a/include/overlay_29_02319F8C.h b/include/overlay_29_02319F8C.h
index a9d9fb31..7146ec1e 100644
--- a/include/overlay_29_02319F8C.h
+++ b/include/overlay_29_02319F8C.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02319F8C(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02319F8C_H
diff --git a/include/overlay_29_0231B194.h b/include/overlay_29_0231B194.h
index 20e13ab4..5ba77238 100644
--- a/include/overlay_29_0231B194.h
+++ b/include/overlay_29_0231B194.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__0231B194(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0231B194_H
diff --git a/include/overlay_29_0231CBC8.h b/include/overlay_29_0231CBC8.h
index d1627c1f..26eca49d 100644
--- a/include/overlay_29_0231CBC8.h
+++ b/include/overlay_29_0231CBC8.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__0231CBC8(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0231CBC8_H
diff --git a/include/overlay_29_0231EDD8.h b/include/overlay_29_0231EDD8.h
index e7e40b46..980a5476 100644
--- a/include/overlay_29_0231EDD8.h
+++ b/include/overlay_29_0231EDD8.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__0231EDD8(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0231EDD8_H
diff --git a/include/overlay_29_0231F570.h b/include/overlay_29_0231F570.h
index 5828eff1..aabf3347 100644
--- a/include/overlay_29_0231F570.h
+++ b/include/overlay_29_0231F570.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__0231F570(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0231F570_H
diff --git a/include/overlay_29_0231FBFC.h b/include/overlay_29_0231FBFC.h
index ebd3fd6a..45c6fa10 100644
--- a/include/overlay_29_0231FBFC.h
+++ b/include/overlay_29_0231FBFC.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__0231FBFC(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0231FBFC_H
diff --git a/include/overlay_29_0232017C.h b/include/overlay_29_0232017C.h
index f07692e5..81b49432 100644
--- a/include/overlay_29_0232017C.h
+++ b/include/overlay_29_0232017C.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__0232017C(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0232017C_H
diff --git a/include/overlay_29_02320764.h b/include/overlay_29_02320764.h
index bc2f784e..9aadedc4 100644
--- a/include/overlay_29_02320764.h
+++ b/include/overlay_29_02320764.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02320764(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02320764_H
diff --git a/include/overlay_29_02321438.h b/include/overlay_29_02321438.h
index 2b1ad77c..a07cf318 100644
--- a/include/overlay_29_02321438.h
+++ b/include/overlay_29_02321438.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02321438(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02321438_H
diff --git a/include/overlay_29_02325620.h b/include/overlay_29_02325620.h
index 4613e422..eb9be8bb 100644
--- a/include/overlay_29_02325620.h
+++ b/include/overlay_29_02325620.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02325620(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02325620_H
diff --git a/include/overlay_29_0232800C.h b/include/overlay_29_0232800C.h
index 0ce4bec6..d517c962 100644
--- a/include/overlay_29_0232800C.h
+++ b/include/overlay_29_0232800C.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValidMoveEffects__0232800C(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0232800C_H
diff --git a/include/overlay_29_0232A3D8.h b/include/overlay_29_0232A3D8.h
index 46aec519..fd7b19a8 100644
--- a/include/overlay_29_0232A3D8.h
+++ b/include/overlay_29_0232A3D8.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValidMoveEffects__0232A3D8(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0232A3D8_H
diff --git a/include/overlay_29_0232C500.h b/include/overlay_29_0232C500.h
index 9ebcc0e2..e1863a3c 100644
--- a/include/overlay_29_0232C500.h
+++ b/include/overlay_29_0232C500.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValidMoveEffects__0232C500(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0232C500_H
diff --git a/include/overlay_29_0232E250.h b/include/overlay_29_0232E250.h
index 939c229d..9a628fa8 100644
--- a/include/overlay_29_0232E250.h
+++ b/include/overlay_29_0232E250.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValidMoveEffects__0232E250(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0232E250_H
diff --git a/include/overlay_29_0232E840.h b/include/overlay_29_0232E840.h
index 4cc083a9..138a5665 100644
--- a/include/overlay_29_0232E840.h
+++ b/include/overlay_29_0232E840.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__0232E840(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0232E840_H
diff --git a/include/overlay_29_02333FAC.h b/include/overlay_29_02333FAC.h
index 7d474937..e78c110f 100644
--- a/include/overlay_29_02333FAC.h
+++ b/include/overlay_29_02333FAC.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02333FAC(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02333FAC_H
diff --git a/include/overlay_29_023350D8.h b/include/overlay_29_023350D8.h
index 2b2f9b51..cabcf550 100644
--- a/include/overlay_29_023350D8.h
+++ b/include/overlay_29_023350D8.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__023350D8(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_023350D8_H
diff --git a/include/overlay_29_02337CA8.h b/include/overlay_29_02337CA8.h
index 24118af3..fb94b52c 100644
--- a/include/overlay_29_02337CA8.h
+++ b/include/overlay_29_02337CA8.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02337CA8(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02337CA8_H
diff --git a/include/overlay_29_02344AF8.h b/include/overlay_29_02344AF8.h
index 671bd854..162c9637 100644
--- a/include/overlay_29_02344AF8.h
+++ b/include/overlay_29_02344AF8.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02344AF8(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02344AF8_H
diff --git a/include/overlay_29_02345698.h b/include/overlay_29_02345698.h
index 9b5ece5a..c01acc6d 100644
--- a/include/overlay_29_02345698.h
+++ b/include/overlay_29_02345698.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02345698(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02345698_H
diff --git a/include/overlay_29_02347BA4.h b/include/overlay_29_02347BA4.h
index 7b31abd8..5478d98e 100644
--- a/include/overlay_29_02347BA4.h
+++ b/include/overlay_29_02347BA4.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__02347BA4(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_02347BA4_H
diff --git a/include/overlay_29_0234987C.h b/include/overlay_29_0234987C.h
index 394e3cc9..9e7665a5 100644
--- a/include/overlay_29_0234987C.h
+++ b/include/overlay_29_0234987C.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__0234987C(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0234987C_H
diff --git a/include/overlay_29_0234DDD0.h b/include/overlay_29_0234DDD0.h
index 02cef4bd..ecdec2d0 100644
--- a/include/overlay_29_0234DDD0.h
+++ b/include/overlay_29_0234DDD0.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__0234DDD0(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0234DDD0_H
diff --git a/include/overlay_29_0234EC14.h b/include/overlay_29_0234EC14.h
index ace66ba7..fc86e6d5 100644
--- a/include/overlay_29_0234EC14.h
+++ b/include/overlay_29_0234EC14.h
@@ -3,6 +3,9 @@
 
 #include "dungeon_mode.h"
 
+// Checks if an entity pointer points to a valid entity (not entity type 0, which represents no entity).
+// entity: entity pointer
+// return: bool
 u8 EntityIsValid__0234EC14(struct entity *entity);
 
 #endif //PMDSKY_OVERLAY_29_0234EC14_H