Comments (2)
Hi Ziyuan, thanks for opening this issue. I used IntelliJ IDEA's build-in javadoc generator with Forge's source code to generate HTML files. Detailed procedures are described below.
Clone the repo to your local machine. You may change the branch name to clone other versions.
git clone --branch 1.16.x https://github.com/MinecraftForge/MinecraftForge.git
Import Forge to IntelliJ IDEA. Simply drag & drop the Forge folder into IntelliJ IDEA's starting menu.
(Optional) Run ./gradlew setup
to set up the project. This will download Minecraft's source codes and mappings. Skip this step if you only need javadoc from package net.minecraftforge.*
(i.e., you don't need javadoc from com.mojang.*
or net.minecraft.*
)
Delete Forge/projects/clean
folder since it causes conflicts during javadoc generation.
Open IntelliJ IDEA, click Menu Bar
- Tools
- Generate JavaDoc...
Click OK after setting all parameters. Wait, and all done.
I never tried to generate HTML with javadoc command in command line, but it should also work. I hope this may help you!
from forgejavadocs-ng.
Thank you so much for your quick response and detailed explanation. You are absolutely correct. I should have done the javadoc using gradle instead of at command line, where it's reporting missing some related packages outside of Forge. Anyway, I used IntelliJ and the above steps work nicely. And thanks for the tip to delete the /clean folder
from forgejavadocs-ng.
Related Issues (4)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from forgejavadocs-ng.