Skip to content

Latest commit

 

History

History
32 lines (26 loc) · 1.64 KB

README.md

File metadata and controls

32 lines (26 loc) · 1.64 KB
Raw

Documented DataFixerUpper

Javadocs Version

This is a set of javadoc patches which add documentation to Mojang's DataFixerUpper library, alongside tooling to apply and generate these patches and publish modified versions of DFU with documentation present.

To use

Add the maven repository to your build.gradle and configure gradle to replace the normal DFU with the modified, documented variant:

repositories {
    maven {
        url = 'https://maven.lukebemish.dev/releases/'
    }
}

configurations.configureEach {
    resolutionStrategy.eachDependency { DependencyResolveDetails details ->
        if (details.requested.group == 'com.mojang' && details.requested.name == 'datafixerupper') {
            details.useTarget "dev.lukebemish:documenteddfu:${documentedDfuVersion}"
        }
    }
}

To contribute

Clone this repository and run the setup task. This will create folders with modified and clean DFU versions, and apply the javadoc patches to the modified version. Make any modifications you would like to the modified version, and then run generatePatches to generate doc patches (JSON representations of added/changed docs) from the modified version.