improve itzako.c names and docs - #3592
Closed
beammeupscottyyy wants to merge 3 commits into
Closed
beammeupscottyyy wants to merge 3 commits into
beammeupscottyyy wants to merge 3 commits into
Conversation
ribbanya
requested changes
Oct 1, 2026
beammeupscottyyy
force-pushed
the
pr-itzako
branch
from
October 1, 2026 17:39
ab68772 to
8256cda
Compare
beammeupscottyyy
force-pushed
the
pr-itzako
branch
from
October 1, 2026 17:45
8256cda to
2fb0fd6
Compare
- Switch to autobrief for function documentation in itzako.h - Remove empty/boilerplate doc comments from itzako.c - Rename rotation_factor to facing_dir per maintainer review - Remove noisy module prefix and streamline file header
Contributor
Author
|
Addressed review feedback:
|
This file contains hidden or 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
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.
Pull Request: Improve
it/itzako.cNames and DocumentationSummary
This PR provides a focused, granular documentation pass for the
it/itzako.c(Fighting Wireframes) item module. It adds standard Doxygen headers to the interface functions and renames opaque local variables/arguments to clarify the item's physics and spawning logic, fully preserving all matching assembly.Granular Reasoning
Function Names & Headers
All 26 exported
it_8027xxxxfunctions initzako.handitzako.chave been given@briefDoxygen headers to explain their mechanical purpose rather than just their memory address. For example:it_8027CC88: Identified as the rare item drop evaluator (e.g. dropping trophies or rare items upon a Zako's defeat).it_8027CE64: Identified as a Game&Watch specific initialization hook that reads the outline color.it_8027BBF4/it_8027C0F0: Identified as rotation math evaluating terrain collision normals for bouncing Zakos.Variable Renames
Standardized ambiguous decompiled registers to match the physics logic they represent:
arg0→pos(Vec3 position offsets).arg1→target(Vec3 targets or velocity vectors).arg8→rotation_factor(Used in Euler angle / quaternion multiplication for spins).arg_func→callback_func(Function pointer forit_8027C824iterator).arg_attr_address→attr_address(Game&Watch data blob pointer).Why This Should Be Merged
As requested in #3591 and adhering to the precedent set by #2778 (
improve itflipper.c names), this is a strictly scoped PR focusing on a single, isolated module. No structural logic is changed, guaranteeing a 100% safe byte-match. It dramatically improves the readability of the Zako system for future Multi-Man Melee modding.Testing: Verified with
clang -fsyntax-onlyto ensure zero compilation errors.