Update Docs: Split up z64.h#3283
Closed
inspectredc wants to merge 5 commits intoHarbourMasters:developfrom
Closed
Conversation
Merged
Contributor
@inspectredc does this make sense to continue as a PR or would a github issue suffice? |
Member
Author
|
I don't mind having an issue to keep going if others want to contribute, but I think I will still want to do this anyway once I get the time |
Contributor
|
i went ahead and made an issue to track this instead. #4992 |
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.
This will be quite a large one and I will split this up into smaller PRs once complete but seems much easier to keep a centralised doc since there may be things that rely on each other somewhat.
The process for this is to split up the structs, functions and variables found in z64.h, variables.h and functions.h based on their current state in decomp. All corresponding changes in naming will be updated and newly introduced macros/enums will be used.
Later (in a separate PR) a second pass will be done to update the c files to remove magic numbers and cover other changes that were made in decomp when these splits were made.
This will be my way of keeping track of the current progress of the include files:
Build Artifacts