document poffin.c and poffin case struct #339
Open
+148
−138
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Viperio19
reviewed
Jan 17, 2025
lhearachel
requested changes
Jan 17, 2025
|
|
||
| #include "poffin.h" | ||
|
|
||
| typedef struct PoffinCase { |
There was a problem hiding this comment.
polish: In general, we try to zip these structures up into the owning module's header file. struct-only headers are reserved for special cases when needed for untangling circular dependencies or sharing definitions with build-tooling.
| #ifndef POKEPLATINUM_STRUCT_0202A93C_H | ||
| #define POKEPLATINUM_STRUCT_0202A93C_H | ||
| #ifndef POKEPLATINUM_STRUCT_POFFIN_H | ||
| #define POKEPLATINUM_STRUCT_POFFIN_H | ||
|
|
||
| typedef struct { |
There was a problem hiding this comment.
polish: As with the above comment (and also for the struct_decls/poffin_case_decl.h file, as well):
- Zip this definition into
include/poffin.h - Replace all the inclusions of
struct_defs/poffin.hwithpoffin.h - Delete this file (and
struct_decls/poffin_case_decl.h).
| @@ -26,7 +28,7 @@ BOOL sub_0202A914(Poffin *poffin) | |||
|
|
|||
| void Poffin_clear(Poffin *poffin) | |||
There was a problem hiding this comment.
Suggested change
| void Poffin_clear(Poffin *poffin) | |
| void Poffin_Clear(Poffin *poffin) |
Similarly (github will not let me do this on the associated lines):
-Poffin *Poffin_malloc(int heapID)
+Poffin *Poffin_New(int heapID)-void Poffin_copy(Poffin *src, Poffin *dest)
+void Poffin_Copy(Poffin *src, Poffin *dest)| break; | ||
| } | ||
| } // skips rest of execution, reached end of poffin case |
There was a problem hiding this comment.
polish: Remove this comment (unnecessary).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As per description.
Only undocumented function in
poffin.cnow issub_0202A9E4which seems to be related in some way to the cooking minigame in which you make poffins.Renames some headers appropriately and notably includes the
poffin.hheader directly intostruct_defs/poffin_case.hto use theMAX_POFFINSmacro as the array size.