Package net.kyori.indra.crossdoc

Interface NameBasedProjectDocumentationUrlProvider

All Superinterfaces:
ProjectDocumentationUrlProvider
public interface NameBasedProjectDocumentationUrlProvider extends ProjectDocumentationUrlProvider
A documentation URL provider that generates a relative URL based on the project name.

The final URL will be in the format <project name>[/<version>], where the configured prefix is stripped from the project name if it is present.

Since:
2.1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gradle.api.provider.Property<Boolean>
    getLowercaseProjectName()
    Get whether to normalize project names by lowercasing them.
    org.gradle.api.provider.Property<String>
    getProjectNamePrefix()
    A prefix that will be stripped from project names when building the URL, if it is present.
    org.gradle.api.provider.Property<String>
    getVersion()
    A version string that will be appended.

    Methods inherited from interface net.kyori.indra.crossdoc.ProjectDocumentationUrlProvider

    createUrl

  • Method Details

    • getVersion

      @Input @Optional org.gradle.api.provider.Property<String> getVersion()
      A version string that will be appended.

      This will be set to the project version by default.

      Returns:
      the version component of the generated URL
      Since:
      2.1.0

    • getProjectNamePrefix

      @Input @Optional org.gradle.api.provider.Property<String> getProjectNamePrefix()
      A prefix that will be stripped from project names when building the URL, if it is present.
      Returns:
      the project name prefix
      Since:
      2.1.0

    • getLowercaseProjectName

      @Input org.gradle.api.provider.Property<Boolean> getLowercaseProjectName()
      Get whether to normalize project names by lowercasing them.
      Returns:
      the lowercase property
      Since:
      2.2.0