Package net.kyori.indra.crossdoc

Interface CrossdocExtension

public interface CrossdocExtension
Configuration for the crossdoc plugin, applicable across multiple tasks.

  • Method Details

    • baseUrl

      org.gradle.api.provider.Property<String> baseUrl()
      The base URL where the eventually published Javadoc will be hosted.

      If this URL does not end with a '/', one will be appended automatically.

      Returns:
      the base URL property
      Since:
      2.1.0

    • baseUrl

      default void baseUrl(String baseUrl)
      Set the base URL where the eventually published Javadoc will be hosted.

      If this URL does not end with a '/', one will be appended automatically.

      Parameters:
      baseUrl - the base URL
      Since:
      2.1.0

    • baseUrl

      default void baseUrl(org.gradle.api.provider.Provider<? extends String> baseUrl)
      Set the base URL where the eventually published Javadoc will be hosted.

      If this URL does not end with a '/', one will be appended automatically.

      Parameters:
      baseUrl - the base URL
      Since:
      2.1.0

    • projectDocumentationUrlProvider

      org.gradle.api.provider.Property<ProjectDocumentationUrlProvider> projectDocumentationUrlProvider()
      The default provider to use for generating project documentation.

      This property will default to a standard implementation appending the project version to the project name.

      Returns:
      a property providing the project documentation url
      Since:
      2.1.0

    • nameBasedDocumentationUrlProvider

      void nameBasedDocumentationUrlProvider(org.gradle.api.Action<? super NameBasedProjectDocumentationUrlProvider> action)
      Set the documentation provider to a standard implementation.

      The computed URLs will be in the format <project name (stripped of prefix)>[/<version>].

      Since:
      2.1.0
      See Also: