Skip to main content

Javadocs

Javadocs are the official API documentation for PetarLib, generated from the source code comments.

Online Javadocs​

The latest Javadocs are available at: https://jd.petarmc.com

Generating Javadocs Locally​

If you want to generate the Javadocs locally from the source code:

  1. Follow the steps in Building from Source to clone and set up the project.
  2. Run the javadoc task: 
    ./gradlew javadoc
  3. The generated documentation will be in the build/docs directory.
  4. Open javadoc/index.html in your web browser to view the documentation.

This is useful for development or offline access.