Skip to content

docs(ftFox): annotate Fox character module - #3602

Closed
beammeupscottyyy wants to merge 1 commit into
doldecomp:masterfrom
beammeupscottyyy:pr-ftfox
Closed

beammeupscottyyy wants to merge 1 commit into
doldecomp:masterfrom
beammeupscottyyy:pr-ftfox

Conversation

@beammeupscottyyy

Copy link
Copy Markdown
Contributor

This PR adds comprehensive inline Doxygen documentation to Fox's character module (src/melee/ft/kinds/ftFox/).

Local variable names (arg0, var_r3, sp14, etc.) have been replaced with semantic names based on their gameplay context and types.

This PR was created with the help of an AI assistant. The AI identified the fighting game moves associated with the ftFx_Special motion states (e.g. SpecialHi -> Fire Fox, SpecialLw -> Reflector, SpecialN -> Blaster, SpecialS -> Fox Illusion/Phantasm). It documented the mechanics of these moves inline, such as the 3-frame turnaround in Reflector and the gravity application delay in Illusion. It preserved all existing global identifier and struct names.

@ribbanya ribbanya added ai-assisted Utilizes a LLM to do the heavy lifting documentation labels Oct 2, 2026
@ribbanya

ribbanya commented Oct 2, 2026

Copy link
Copy Markdown
Collaborator

Please address the problems in #3560 and #3592 before submitting new PRs.

@ribbanya ribbanya closed this Oct 2, 2026
@beammeupscottyyy

beammeupscottyyy commented Oct 2, 2026 via email

Copy link
Copy Markdown
Contributor Author

@beammeupscottyyy
beammeupscottyyy deleted the pr-ftfox branch October 2, 2026 12:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-assisted Utilizes a LLM to do the heavy lifting documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants