Package net.kyori.indra.crossdoc

Class CrossdocPlugin

  • All Implemented Interfaces:
    net.kyori.mammoth.ProjectPlugin, org.gradle.api.Plugin<org.gradle.api.Project>
    public class CrossdocPlugin
extends java.lang.Object
implements net.kyori.mammoth.ProjectPlugin
    Generate offline links to Javadoc for other projects within the same multi-module build.

    This plugin currently only applies to the Javadoc published by the main source set, since conventions for alternate publications are unclear.

    Behavior when this plugin is only applied to some but not all projects with published Javadoc within a single build is undefined.

    Since:
    2.1.0

    • Constructor Summary

      Constructors 
      Constructor Description
      CrossdocPlugin()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void apply​(@NotNull org.gradle.api.Project project, @NotNull org.gradle.api.plugins.PluginContainer plugins, @NotNull org.gradle.api.plugins.ExtensionContainer extensions, @NotNull org.gradle.api.tasks.TaskContainer tasks)  

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface net.kyori.mammoth.ProjectPlugin

        apply, apply, minimumGradleVersion

    • Field Detail

      • GENERATE_OFFLINE_LINKS_TASK_NAME

        public static final java.lang.String GENERATE_OFFLINE_LINKS_TASK_NAME
        Name for the main source set GenerateOfflineLinks task.
        Since:
        2.1.0
        See Also:
        Constant Field Values

      • COPY_JAVADOC_TASK_NAME

        public static final java.lang.String COPY_JAVADOC_TASK_NAME
        Name for the main source set CopyJavadoc task.
        Since:
        2.1.0
        See Also:
        Constant Field Values

      • OFFLINE_LINKED_JAVADOC_CONFIGURATION_NAME

        public static final java.lang.String OFFLINE_LINKED_JAVADOC_CONFIGURATION_NAME
        The configuration used for resolving projects for javadoc linking.
        Since:
        2.1.0
        See Also:
        Constant Field Values

      • EXTENSION_NAME

        public static final java.lang.String EXTENSION_NAME
        The name of the extension created on a project to configure this plugin.
        Since:
        2.1.0
        See Also:
        Constant Field Values

    • Constructor Detail

      • CrossdocPlugin

        public CrossdocPlugin()

    • Method Detail

      • apply

        public void apply​(@NotNull
                  @NotNull org.gradle.api.Project project,
                  @NotNull
                  @NotNull org.gradle.api.plugins.PluginContainer plugins,
                  @NotNull
                  @NotNull org.gradle.api.plugins.ExtensionContainer extensions,
                  @NotNull
                  @NotNull org.gradle.api.tasks.TaskContainer tasks)
        Specified by:
        apply in interface net.kyori.mammoth.ProjectPlugin