Sdev/javadocs #2674
Open
Sdev/javadocs #2674
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
It's bad form and I'm eepy so I did this earlier
This took so long I'm dying
These are getting harder 😭
All I'm going for now. A lot of the docs are copy-paste
stanieldev
added
Documentation
Ghostipedia
requested changes
Dec 30, 2024
screret
requested changes
Dec 30, 2024
src/main/java/com/gregtechceu/gtceu/api/block/MaterialBlock.java
Outdated
Show resolved
Hide resolved
src/main/java/com/gregtechceu/gtceu/api/block/MaterialPipeBlock.java
Outdated
Show resolved
Hide resolved
To appease the Tech22
screret
requested changes
Jan 4, 2025
| @@ -71,7 +70,7 @@ public static BlockColor tintedColor() { | |||
| return pipe.getFrameMaterial().getMaterialSecondaryRGB(); | |||
| } | |||
| } | |||
| if (pipe.isPainted()) { | |||
| else if (pipe.isPainted()) { | |||
There was a problem hiding this comment.
this shouldn't be an else if, it should fall through to this if the frame material checks fail IMO.
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.
What
This PR adds a bunch of JavaDocs for functions that previously didn't have them, were unclear, or were outdated.
Implementation Details
When reviewing, I would look for my descriptions being proper, since some of them I had to figure out after reading the function's contents multiple times.
Outcome
Hopefully the readability will increase and help with future development.
Potential Compatibility Issues
I didn't change any variable names, instead leaving them as TODOs while I was working.
They can be removed in the future when they are either changed or rejected.