Add AI generated Javadoc #140
Open
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
Rongmario
requested changes
May 13, 2024
There was a problem hiding this comment.
Comments for the following classes are fine:
SplashProgressDungeonHooksCapabilityEnergy(partially, I've left comments)IRenderHandler(partially, I've left comments)MinecraftForgeClient(partially, I've left comments)
I wouldn't rely on AI for generating javadocs especially in and around Minecraft and Forge code, as it wouldn't have enough context. As you can see, a lot of it are redundant and verbose, especially for methods that are self-explanatory.
I've kept some docs that does help clarify things, please amend and we'll look to pull this in.
Ecdcaeb
suggested changes
May 14, 2024
src/main/java/net/minecraftforge/fml/client/SplashProgress.java
Outdated
Show resolved
Hide resolved
src/main/java/net/minecraftforge/fml/client/GuiSortingProblem.java
Outdated
Show resolved
Hide resolved
src/main/java/net/minecraftforge/fml/client/GuiSortingProblem.java
Outdated
Show resolved
Hide resolved
Ecdcaeb's suggestion Co-authored-by: Hileb <107909747+Ecdcaeb@users.noreply.github.com>
number 2! Co-authored-by: Hileb <107909747+Ecdcaeb@users.noreply.github.com>
number 3! Co-authored-by: Hileb <107909747+Ecdcaeb@users.noreply.github.com>
Co-authored-by: Hileb <107909747+Ecdcaeb@users.noreply.github.com>
Co-authored-by: Hileb <107909747+Ecdcaeb@users.noreply.github.com>
…m/Cleanroom into javadoc-thats-not-needed
Rongmario
requested changes
May 15, 2024
src/main/java/net/minecraftforge/fml/client/GuiSortingProblem.java
Outdated
Show resolved
Hide resolved
Ecdcaeb
reviewed
May 15, 2024
Co-authored-by: Hileb <107909747+Ecdcaeb@users.noreply.github.com>
Ecdcaeb
suggested changes
May 17, 2024
src/main/java/net/minecraftforge/client/FluidContainerColorer.java
Outdated
Show resolved
Hide resolved
…java Co-authored-by: Hileb <107909747+Ecdcaeb@users.noreply.github.com>
Co-authored-by: Hileb <107909747+Ecdcaeb@users.noreply.github.com>
Ecdcaeb
suggested changes
Jun 7, 2024
| @@ -26,14 +26,32 @@ | |||
|
|
|||
| import javax.annotation.Nonnull; | |||
|
|
|||
There was a problem hiding this comment.
FluidContainerColorer is not a api. No java docs is needed here.
| @@ -26,8 +26,17 @@ | |||
| import net.minecraftforge.fluids.FluidRegistry; | |||
| import net.minecraftforge.fml.common.eventhandler.SubscribeEvent; | |||
|
|
|||
There was a problem hiding this comment.
ForgeClientHandler is not a api. No java docs is needed here.
src/main/java/net/minecraftforge/client/MinecraftForgeClient.java
Outdated
Show resolved
Hide resolved
| public static BlockRenderLayer getRenderLayer() | ||
| { | ||
| return ForgeHooksClient.renderLayer.get(); | ||
| } | ||
|
|
||
| /** |
| @@ -72,14 +69,6 @@ public static Locale getLocale() | |||
| stencilBits.set(0,8); | |||
| } | |||
|
|
|||
| /** | |||
src/main/java/net/minecraftforge/fml/client/ExtendedServerListData.java
Outdated
Show resolved
Hide resolved
| @@ -25,16 +25,35 @@ | |||
| import java.io.File; | |||
| import java.util.Map.Entry; | |||
|
|
|||
There was a problem hiding this comment.
GuiDupesFound is not a API, java doc is not needed.
| @@ -21,15 +21,33 @@ | |||
|
|
|||
| import net.minecraft.network.datasync.DataSerializer; | |||
|
|
|||
There was a problem hiding this comment.
No need for such complicated Java doc
Co-authored-by: Hileb <107909747+Ecdcaeb@users.noreply.github.com>
Co-authored-by: Hileb <107909747+Ecdcaeb@users.noreply.github.com>
Co-authored-by: Hileb <107909747+Ecdcaeb@users.noreply.github.com>
…Data.java Co-authored-by: Hileb <107909747+Ecdcaeb@users.noreply.github.com>
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 PR:
Why:
Notice: I have no idea how to test this! Could totally break everything! (Please teach me)