New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Javadoc doesn't build. #9832
Comments
Also, at the start of the build I get:
|
After removing the two lines that caused errors, I get: `> Task :fmlearlydisplay:javadoc FAILED FAILURE: Build failed with an exception.
I assume that people do actually use JavaDoc when creating mods, rather than some sort of psychic power that I lack, and as such that they manage to actually generate the javadocs? But this is getting silly! |
Most people do not use stand alone javadoc, they use their IDE to navigate around the source and read the docs it displays. |
What is the syntax to specify "-Xdoclint:non"? Where do I add this? I tried:
|
Many of the bugs are documentation errors. Whether the documentation refers to a parameter that does not exist or has had a name change, or the documentation refers to a class or somesuch that no longer exists. I am fixing things as best as I can, but in the case of some "reference not found" errors I am simply deleting the relevant sentence. |
Do I have to clone to do a push request? I created a branch from 1.20.x but cannot push it or the changes on it. I would prefer not to clone just to create a merge request so I am attaching the diffs here. |
Also, the generated javadoc does not include any of the underlying Minecraft stuff, which is the stuff I am really after! How do I generate javadocs like these: https://nekoyue.github.io/ForgeJavaDocs-NG/javadoc/1.19.3/ |
Minecraft Version: 1.20.x
Forge Version: Branch 1.20.x, commit ed2ba0f
Logs:
Steps to Reproduce:
If these are not the correct steps to generate the javadocs, then what are? I cannot find any up to date information on generating javadocs on the command line (Linux).
Description of issue:
Javadocs are not generated.
This was also reported in December 2022 on the forums at https://forums.minecraftforge.net/topic/118731-is-there-a-forge-api-or-javadoc/ where the OP states "I have unsuccessfully tried to create the Javadoc from the MinecraftForge Github repository.".
This issue may be resolved by adding documentation on the steps required to generate the JavaDocs, of which there currently appears to be none.
The text was updated successfully, but these errors were encountered: