add explanatory comment about GetMonData()/GetBoxMonData()

1 files changed, 6 insertions, 0 deletions

diff --git a/include/pokemon.h b/include/pokemon.h
index e82cd0e54..43ff1b500 100644
--- a/include/pokemon.h
+++ b/include/pokemon.h
@@ -375,8 +375,14 @@ void GetMonSpriteTemplate_803C5A0(u16 species, u8 a2);
 void EncryptBoxMon(struct BoxPokemon *boxMon);
 void DecryptBoxMon(struct BoxPokemon *boxMon);
 union PokemonSubstruct *GetSubstruct(struct BoxPokemon *boxMon, u32 personality, u8 substructType);
+
+// These are full type signatures for GetMonData() and GetBoxMonData(),
+// but they are not used since some code erroneously omits the third arg.
+// u32 GetMonData(struct Pokemon *mon, s32 field, u8 *data);
+// u32 GetBoxMonData(struct BoxPokemon *boxMon, s32 field, u8 *data);
 u32 GetMonData();
 u32 GetBoxMonData();
+
 void SetMonData(struct Pokemon *mon, s32 field, const u8 *data);
 void SetBoxMonData(struct BoxPokemon *boxMon, s32 field, const u8 *data);
 void CopyMon(void *dest, void *src, size_t size);