IndustrialCraft2 API javadoc failing!

CJMinecraft · Oct 24th 2017

So I am currently trying to build the latest version of my API but I am having persistent errors with the IC₂ API. I am trying to create a TileEntity which works with IC₂ but every time I build (and I am on the latest Gradle build 4.2.1 and the latest java version and the latest 1.11.2 mapping stable_32) I get this error with the javadoc on IC₂:

Code

:javadoc
USERPATH\.gradle\caches\modules-2\files-2.1\net.industrial-craft\industrialcraft-2\2.7.9-ex111\3c815f473c4c1cf619cd1e042ebd3ef8f9ba5b5d\industrialcraft-2-2.7.9-ex111-api.jar(ic2/api/item/IElectricItem.java):16: warning: no @param for stack        boolean canProvideEnergy(ItemStack stack);                ^
USERPATH\.gradle\caches\modules-2\files-2.1\net.industrial-craft\industrialcraft-2\2.7.9-ex111\3c815f473c4c1cf619cd1e042ebd3ef8f9ba5b5d\industrialcraft-2-2.7.9-ex111-api.jar(ic2/api/item/IElectricItem.java):23: warning: no @param for stack        double getMaxCharge(ItemStack stack);               ^
USERPATH\.gradle\caches\modules-2\files-2.1\net.industrial-craft\industrialcraft-2\2.7.9-ex111\3c815f473c4c1cf619cd1e042ebd3ef8f9ba5b5d\industrialcraft-2-2.7.9-ex111-api.jar(ic2/api/item/IElectricItem.java):33: warning: no @param for stack        int getTier(ItemStack stack);            ^
USERPATH\.gradle\caches\modules-2\files-2.1\net.industrial-craft\industrialcraft-2\2.7.9-ex111\3c815f473c4c1cf619cd1e042ebd3ef8f9ba5b5d\industrialcraft-2-2.7.9-ex111-api.jar(ic2/api/item/IElectricItem.java):40: warning: no @param for stack        double getTransferLimit(ItemStack stack);               ^
USERPATH\.gradle\caches\modules-2\files-2.1\net.industrial-craft\industrialcraft-2\2.7.9-ex111\3c815f473c4c1cf619cd1e042ebd3ef8f9ba5b5d\industrialcraft-2-2.7.9-ex111-api.jar(ic2/api/energy/tile/IEnergyAcceptor.java):23: warning: no @return        boolean acceptsEnergyFrom(IEnergyEmitter emitter, EnumFacing side);                ^
USERPATH\.gradle\caches\modules-2\files-2.1\net.industrial-craft\industrialcraft-2\2.7.9-ex111\3c815f473c4c1cf619cd1e042ebd3ef8f9ba5b5d\industrialcraft-2-2.7.9-ex111-api.jar(ic2/api/energy/tile/IEnergySink.java):14: error: bad use of '>'         * Make sure that injectEnergy() does accepts energy if demandsEnergy() returns anything > 0.                                                                                                 ^
USERPATH\.gradle\caches\modules-2\files-2.1\net.industrial-craft\industrialcraft-2\2.7.9-ex111\3c815f473c4c1cf619cd1e042ebd3ef8f9ba5b5d\industrialcraft-2-2.7.9-ex111-api.jar(ic2/api/energy/tile/IEnergySink.java):16: error: unknown tag: note         * @note Modifying the energy net from this method is disallowed.           ^
USERPATH\.gradle\caches\modules-2\files-2.1\net.industrial-craft\industrialcraft-2\2.7.9-ex111\3c815f473c4c1cf619cd1e042ebd3ef8f9ba5b5d\industrialcraft-2-2.7.9-ex111-api.jar(ic2/api/energy/tile/IEnergySink.java):26: error: unknown tag: note         * @note Modifying the energy net from this method is disallowed.           ^
USERPATH\.gradle\caches\modules-2\files-2.1\net.industrial-craft\industrialcraft-2\2.7.9-ex111\3c815f473c4c1cf619cd1e042ebd3ef8f9ba5b5d\industrialcraft-2-2.7.9-ex111-api.jar(ic2/api/energy/tile/IEnergySink.java):27: error: unknown tag: note         * @note Return Integer.MAX_VALUE to allow any voltage.           ^
USERPATH\.gradle\caches\modules-2\files-2.1\net.industrial-craft\industrialcraft-2\2.7.9-ex111\3c815f473c4c1cf619cd1e042ebd3ef8f9ba5b5d\industrialcraft-2-2.7.9-ex111-api.jar(ic2/api/energy/tile/IEnergySink.java):43: warning: no @param for voltage        double injectEnergy(EnumFacing directionFrom, double amount, double voltage);               ^
USERPATH\.gradle\caches\modules-2\files-2.1\net.industrial-craft\industrialcraft-2\2.7.9-ex111\3c815f473c4c1cf619cd1e042ebd3ef8f9ba5b5d\industrialcraft-2-2.7.9-ex111-api.jar(ic2/api/energy/tile/IEnergySource.java):13: error: unknown tag: note         * @note Modifying the energy net from this method is disallowed.           ^
USERPATH\.gradle\caches\modules-2\files-2.1\net.industrial-craft\industrialcraft-2\2.7.9-ex111\3c815f473c4c1cf619cd1e042ebd3ef8f9ba5b5d\industrialcraft-2-2.7.9-ex111-api.jar(ic2/api/energy/tile/IEnergySource.java):32: error: unknown tag: note         * @note Modifying the energy net from this method is disallowed.           ^
PATH\src\main\java\cofh\api\energy\IEnergyStorage.java:41: warning: no @return        int getEnergyStored();            ^
PATH\src\main\java\cofh\api\energy\IEnergyStorage.java:46: warning: no @return        int getMaxEnergyStored();            ^
6 errors
8 warnings
:javadoc FAILED

Display More

Where PATH represents the path to the mod and USERPATH represents the path to the user i.e. C:/Users/USERNAME

The build file is as follows:

Code: build.gradle

buildscript {
    repositories {
        jcenter()
        maven { url = "http://files.minecraftforge.net/maven" }     }
   dependencies {
        classpath 'net.minecraftforge.gradle:ForgeGradle:2.2-SNAPSHOT'
   }
}
apply plugin: 'net.minecraftforge.gradle.forge'
//Only edit below this line, the above code adds and enables the necessary things for Forge to be setup.


version = "0.0.2.4"
group = "cjminecraft.core" // http://maven.apache.org/guides/mini/guide-naming-conventions.html
archivesBaseName = "cjcore-1.11"

sourceCompatibility = targetCompatibility = "1.8" // Need this here so eclipse task generates correctly.
compileJava {
    sourceCompatibility = targetCompatibility = "1.8"
}

task javadocJar(type: Jar, dependsOn: 'javadoc') {
    from "build/docs/javadoc"    classifier "javadoc"
}

task deobfJar(type: Jar) {
    from sourceSets.main.output
    classifier = 'deobf'
}

task srcJar(type: Jar, dependsOn: "sourceMainJava") {
    from sourceSets.main.allSource
    classifier = 'sources'
}

artifacts {
    archives srcJar    archives deobfJar    archives javadocJar
}

minecraft {
    version = "1.11.2-13.20.1.2454"
    runDir = "run"    // the mappings can be changed at any time, and must be in the following format.
    // snapshot_YYYYMMDD   snapshot are built nightly.
    // stable_#            stables are built at the discretion of the MCP team.
    // Use non-default mappings at your own risk. they may not always work.
    // simply re-run your setup task after changing the mappings to update your workspace.
    mappings = "stable_32"    // makeObfSourceJar = false // an Srg named sources jar is made by default. uncomment this to disable.
}

repositories {
    maven {
        name "Tesla"
        url 'http://maven.epoxide.xyz'
    }        maven {
        name = "ic2"
        url = "http://maven.ic2.player.to/"
    }        ivy {
        name "BuildCraft"
        artifactPattern "http://www.mod-buildcraft.com/releases/BuildCraft/[revision]/[module]-[revision](-[classifier]).[ext]"
    }
}

dependencies {
    compile "net.darkhax.tesla:Tesla:1.11-1.3.0.52"
    deobfCompile name: "buildcraft", version: "7.99.7"
    compile 'net.industrial-craft:industrialcraft-2:2.7.9-ex111:api'
}

processResources {
    // this will ensure that this task is redone when the versions change.
    inputs.property "version", project.version
    inputs.property "mcversion", project.minecraft.version
    // replace stuff in mcmod.info, nothing else
    from(sourceSets.main.resources.srcDirs) {
        include 'mcmod.info'
        // replace version and mcversion
        expand 'version':project.version, 'mcversion':project.minecraft.version
    }    // copy everything else except the mcmod.info
    from(sourceSets.main.resources.srcDirs) {
        exclude 'mcmod.info'
    }
}

Display More

Thanks for the help in advance. I really hope I can fix this issue. For the code, visit http://github.com/CJMinecraft01/CJCore

Aroma1997 · Oct 24th 2017

As someone who never used javadoc in gradle or even the javadoc program, I don't know for sure, but to me it looks like this:

javadoc is trying to generate the javadocs for everything in the classpath, including dependencies (which it shouldn't). Try setting up the javadoc build task like JEI does.

Another thing: You're compiling against build 9 of the 1.11 version of IC2. Try using the newest build as a dependency and see if that works.

CJMinecraft · Oct 25th 2017

Thanks for the advice! I have managed to fix this by adding this to my build file:

Code

allprojects {
    tasks.withType(Javadoc) {
        options.addStringOption('Xdoclint:none', '-quiet')
    }
}

Thank you so much!

Share