How do I generate javadocs.

[Jontom Xire]

I was using a javadoc published on the internet, but it only goes up to 19.3. I want to migrate my mode to 1.20.1, specifically forge-1.20.1-47.1.46.

I cloned https://github.com/MinecraftForge/MinecraftForge.git.

I looked around to try and find the exact commit. There is a 1.20.1 branch, but it apparently has tags for 47.1 and 47.2 on it. Isn't version 47.2 for Minecraft 1.20.2?

I have tried to generate javadocs with HEAD of the 1.20.x branch (lots of javadoc errors), the 47.1 tagged commit on the 1.20.1 branch, and the head of the 1.20.1 branch. Nothing works.

I cannot find any information on how to generate javadocs that is up to date. The commands I have tried are:

 

    ./gradlew setup

    ./gradlew javadocs

 

Please can someone tell me how to generate javadocs. Please can someone document it in a README or something. If I am doing the right steps then please can someone help me work out why it doesn't work for me.

 

 

I am really confused. Lots of people make mods all the time and they MUST be using javadocs for it, but how do they no how to generate the javadocs when there are no obvious instructions on how, and generating javadocs from the Forge repo seems to always fail. I found a post on this forum from December 2022 that complained of exactly the same thing.

 

I have also raised a bug for the 1.20.x branch since it is clearly errors in the source code that is causing the javadoc generation failure.

 

 

 

 

[Jontom Xire]

Someone please help.

 

I have generated fixes for all the bugs building javadocs for 1.20.x in the MinecraftForge GitHub repository, but it only includes net.minecraftforge.fml.common and net.minecraftforge.fml.javafmlmod.

 

I need to update my mod from 1.19.3 to 1.20.x and I am getting errors like:

    error: cannot find symbol
    import net.minecraft.world.level.material.Material;
                                             ^
      symbol:   class Material
      location: package net.minecraft.world.level.material
 

To start to fix this I need to be able to search the Minecraft documentation. Only there isn't any!

 

[warjort]

https://parchmentmc.org/