A B C D E G J N O P
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- apply(Project, PluginContainer, ExtensionContainer, TaskContainer) - Method in class net.kyori.indra.crossdoc.CrossdocPlugin
- ARCHIVE - Static variable in interface net.kyori.indra.crossdoc.JavadocPackaging
-
Packaged as an archive, such as a
jar.
B
- baseUrl() - Method in interface net.kyori.indra.crossdoc.CrossdocExtension
-
The base URL where the eventually published Javadoc will be hosted.
- baseUrl(String) - Method in interface net.kyori.indra.crossdoc.CrossdocExtension
-
Set the base URL where the eventually published Javadoc will be hosted.
- baseUrl(Provider<? extends String>) - Method in interface net.kyori.indra.crossdoc.CrossdocExtension
-
Set the base URL where the eventually published Javadoc will be hosted.
C
- COPY_JAVADOC_TASK_NAME - Static variable in class net.kyori.indra.crossdoc.CrossdocPlugin
-
Name for the main source set
CopyJavadoctask. - CopyJavadoc - Class in net.kyori.indra.crossdoc
-
Copy project javadoc into the `adventure-javadoc` directory tree
- CopyJavadoc() - Constructor for class net.kyori.indra.crossdoc.CopyJavadoc
- createUrl(String, String) - Method in interface net.kyori.indra.crossdoc.ProjectDocumentationUrlProvider
-
Create the relative, public-facing URL for the Javadoc for a certain project.
- CrossdocExtension - Interface in net.kyori.indra.crossdoc
-
Configuration for the crossdoc plugin, applicable across multiple tasks.
- CrossdocPlugin - Class in net.kyori.indra.crossdoc
-
Generate offline links to Javadoc for other projects within the same multi-module build.
- CrossdocPlugin() - Constructor for class net.kyori.indra.crossdoc.CrossdocPlugin
D
- DIRECTORY - Static variable in interface net.kyori.indra.crossdoc.JavadocPackaging
-
Published as an exploded directory, the original output format.
- doTransfer() - Method in class net.kyori.indra.crossdoc.CopyJavadoc
E
- EXTENSION_NAME - Static variable in class net.kyori.indra.crossdoc.CrossdocPlugin
-
The name of the extension created on a project to configure this plugin.
G
- GENERATE_OFFLINE_LINKS_TASK_NAME - Static variable in class net.kyori.indra.crossdoc.CrossdocPlugin
-
Name for the main source set
GenerateOfflineLinkstask. - generateArgumentFile() - Method in class net.kyori.indra.crossdoc.GenerateOfflineLinks
- GenerateOfflineLinks - Class in net.kyori.indra.crossdoc
-
Generate an options file containing
-linkofflineinfo for passing intoJavadoctasks - GenerateOfflineLinks() - Constructor for class net.kyori.indra.crossdoc.GenerateOfflineLinks
- getDocumentationUrlProvider() - Method in class net.kyori.indra.crossdoc.CopyJavadoc
- getFileSystemOps() - Method in class net.kyori.indra.crossdoc.CopyJavadoc
- getJavadocFiles() - Method in class net.kyori.indra.crossdoc.CopyJavadoc
- getLinkableArtifacts() - Method in class net.kyori.indra.crossdoc.GenerateOfflineLinks
-
A collection of artifacts on the compile classpath, to generate links t.
- getLinkBaseUrl() - Method in class net.kyori.indra.crossdoc.GenerateOfflineLinks
-
The base URL for submodule links.
- getOutputDirectory() - Method in class net.kyori.indra.crossdoc.CopyJavadoc
- getOutputFile() - Method in class net.kyori.indra.crossdoc.GenerateOfflineLinks
-
The output file that the generated arguments for the
javadoctool will be written to. - getOutputPath() - Method in class net.kyori.indra.crossdoc.CopyJavadoc
- getProjectName() - Method in class net.kyori.indra.crossdoc.CopyJavadoc
- getProjectNamePrefix() - Method in interface net.kyori.indra.crossdoc.NameBasedProjectDocumentationUrlProvider
-
A prefix that will be stripped from project names when building the URL, if it is present.
- getProjectPath() - Method in class net.kyori.indra.crossdoc.CopyJavadoc
- getRootDir() - Method in class net.kyori.indra.crossdoc.CopyJavadoc
- getTempLinkableArtifacts() - Method in class net.kyori.indra.crossdoc.GenerateOfflineLinks
- getUrlProvider() - Method in class net.kyori.indra.crossdoc.GenerateOfflineLinks
-
A provider that computes project URLs, relative to the link base URL.
- getVersion() - Method in interface net.kyori.indra.crossdoc.NameBasedProjectDocumentationUrlProvider
-
A version string that will be appended.
J
- JAVADOC_PACKAGING_ATTRIBUTE - Static variable in interface net.kyori.indra.crossdoc.JavadocPackaging
-
The attribute itself.
- JavadocPackaging - Interface in net.kyori.indra.crossdoc
-
Indicate the packaging of a Javadoc variant.
N
- nameBasedDocumentationUrlProvider(Action<? super NameBasedProjectDocumentationUrlProvider>) - Method in interface net.kyori.indra.crossdoc.CrossdocExtension
-
Set the documentation provider to a standard implementation.
- NameBasedProjectDocumentationUrlProvider - Interface in net.kyori.indra.crossdoc
-
A documentation URL provider that generates a relative URL based on the project name.
- net.kyori.indra.crossdoc - package net.kyori.indra.crossdoc
O
- OFFLINE_LINKED_JAVADOC_CONFIGURATION_NAME - Static variable in class net.kyori.indra.crossdoc.CrossdocPlugin
-
The configuration used for resolving projects for javadoc linking.
P
- projectDocumentationUrlProvider() - Method in interface net.kyori.indra.crossdoc.CrossdocExtension
-
The default provider to use for generating project documentation.
- ProjectDocumentationUrlProvider - Interface in net.kyori.indra.crossdoc
-
A provider that, given a project name will compute the eventual published URL, relative to a separately provided base URL.
All Classes All Packages