Where can I find the JavaDocs for the forge API?

[N!ghthauq]

I'm just starting to use the forge API for Minecraft 1.12.2, and it would be nice to see the JavaDocs so I know all that I can do.

[Cadiboo]

What IDE do you use? How did you set up your workspace. The source should be attached automatically and viewable in your external libraries

[N!ghthauq]

29 minutes ago, Cadiboo said:

What IDE do you use? How did you set up your workspace. The source should be attached automatically and viewable in your external libraries

Oh, sorry. I use Eclipse 2018 - 12, and i used the forge Gradle installation.

 

[Cadiboo]

On 2/27/2019 at 1:58 PM, N!ghthauq said:

i used the forge Gradle installation

What does this mean? Can you explain more?

[N!ghthauq]

I set up my workspace exactly how the forge installation guide told me. My workspace is in the same folder as my eclipse root folder as well if that is what you're asking for.

[JavaMan7]

This is more what your looking for LINK . it teaches you structure.  the docs in eclipse are not helpful  unless you know the basics first.

and this will give you java docs in eclipse.

1. add this line apply plugin: 'eclipse' to build.gradle just under   apply plugin: 'net.minecraftforge.gradle'

2. run gradlew eclipse

3.if eclipse is open restart it 

NOTE: you must build first.

Edited March 4, 2019 by JavaMan7

[FrostBytes]

You can always just generate your own JavaDocs. The Forge source (at least from GradleForge) seldom has JavaDoc comments, and the comments that are there are limited in information. If you really want to comprehend everything, build your own JavaDocs.

2 hours ago, JavaMan7 said:

1. add this line apply plugin: 'eclipse' to build.gradle just under   apply plugin: 'net.minecraftforge.gradle'

2. run gradlew eclipse

3.if eclipse is open restart it 

NOTE: you must build first.

That's not how you build JavaDocs in Eclipse, at least from the time I used the program.
Project > Generate JavaDocs

[JavaMan7]

16 hours ago, FrostBytes said:

That's not how you build JavaDocs in Eclipse, at least from the time I used the program.

They are already built but the paths to them are not thats what the eclipse comand dose 1.13.2+ already has the eclipse plugin buit in. This is the best way to do this and it going to be done this way in the future. And like i said befor forge docs are here the ones in eclipse are just qick references.

[N!ghthauq]

Alright, I thought forge would have their classes, enums, methods, etc. documented.

[Draco18s]

33 minutes ago, N!ghthauq said:

Alright, I thought forge would have their classes, enums, methods, etc. documented.

You mean this?

https://mcforge.readthedocs.io/en/latest/gettingstarted/

[N!ghthauq]

I've been given the link to that many different times. Yes I like it, I think it's good but it confuses me because it doesn't look like any other javadocs I've seen.

[Draco18s]

That's because it isn't autogenerated.

 

Just because Java has a way to docvument things and Forge is written in Java does not mean that all docs are JavaDoc.

 

The intertnal docs and the external docs sever a different purpose.

[N!ghthauq]

So, back to my original question, can I then generate the javadocs? Are they there to be auto-generated?

 

[Draco18s]

19 hours ago, FrostBytes said:

You can always just generate your own JavaDocs. The Forge source (at least from GradleForge) seldom has JavaDoc comments, and the comments that are there are limited in information. If you really want to comprehend everything, build your own JavaDocs.

That's not how you build JavaDocs in Eclipse, at least from the time I used the program.
Project > Generate JavaDocs

Um....let me just look up-thread a bit.

Hmm.

 

[N!ghthauq]

Thanks.

[JavaMan7]

10 hours ago, N!ghthauq said:

Alright, I thought forge would have their classes, enums, methods, etc. documented.

this is the minecraft source code and minecraft forge source code.

Ctrl+space list all field and methods in a class 

public static void main(string args[]){

System.out.


}

hovering over an object will link to its class clicking on it takes you to its source code.

right click on an object and click type hierarchy  

btw this is all of the types that have a registry call type 

the docks are not the best. they don't tell you every thing you may need to dig this should help and i think this is what you are look for maybe?

and there is out line is on the side looks  like this ?

 

 

 

this is a piece of code from EntityType<T> class at first I did not now how to register entitys but this gave me a start point to finger it out. this is to just get you thinking.

   public static final EntityType<EntityTippedArrow> ARROW = register("arrow", EntityType.Builder.create(EntityTippedArrow.class, EntityTippedArrow::new));
   public static final EntityType<EntityBat> BAT = register("bat", EntityType.Builder.create(EntityBat.class, EntityBat::new));

 

 

you now have a reference to just about every thing in terms of docs. 

Edited March 5, 2019 by JavaMan7

[趙子賢]

You can go to Forge 1.12.2-14.23.5.2838 API (MCP stable_39)