Package net.fabricmc.loom.task.tool

Class ValidateModProvidedJavadocTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
net.fabricmc.loom.task.AbstractLoomTask
net.fabricmc.loom.task.tool.ValidateModProvidedJavadocTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
@DisableCachingByDefault public abstract class ValidateModProvidedJavadocTask extends AbstractLoomTask
Checks that the mod-provided javadoc mappings in a specific file are valid. This task can be used together with ModEnigmaTask to author and check mod-provided javadoc files.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    ValidateModProvidedJavadocTask.ErrorReporter
     
    static final class 
    ValidateModProvidedJavadocTask.Validator
     

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer

  • Field Summary

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    ValidateModProvidedJavadocTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    check()
     
    abstract org.gradle.api.provider.Property<String>
    getExpectedNamespace()
    The expected source namespaced for the mappings.
    abstract org.gradle.api.file.ConfigurableFileCollection
    getMappingFiles()
    The mapping files to check.
    abstract org.gradle.api.file.ConfigurableFileCollection
    getMinecraftJars()
    The game jars.
    protected abstract org.gradle.api.problems.Problems
    getProblems()
     

    Methods inherited from class net.fabricmc.loom.task.AbstractLoomTask

    getExtension, getModPlatform

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • ValidateModProvidedJavadocTask

      public ValidateModProvidedJavadocTask()

  • Method Details

    • getMappingFiles

      @InputFiles @SkipWhenEmpty @PathSensitive(NONE) public abstract org.gradle.api.file.ConfigurableFileCollection getMappingFiles()
      The mapping files to check.

    • getMinecraftJars

      @Classpath public abstract org.gradle.api.file.ConfigurableFileCollection getMinecraftJars()
      The game jars. All targeted code elements will need to be in these jars.

    • getExpectedNamespace

      @Input public abstract org.gradle.api.provider.Property<String> getExpectedNamespace()
      The expected source namespaced for the mappings.

    • getProblems

      @Internal @Inject protected abstract org.gradle.api.problems.Problems getProblems()

    • check

      protected void check() throws IOException
      Throws:
      IOException