SgtSilvio / gradle-javadoc-links

Gradle plugin to ease defining Javadoc links

Gradle Javadoc Links Plugin

Gradle plugin to ease defining Javadoc links

• Links to JDK javadoc of the used java version
• Links to javadoc of dependencies (javadoc.io URLs are used by default)
• Links project dependencies offline which enables linking to unpublished versions
  • Works for subprojects (include in settings.gradle)
  • Works for dependencies substituted by included builds (includeBuild in settings.gradle)

How to Use

plugins {
    id("io.github.sgtsilvio.gradle.javadoc-links") version "0.7.0"
}

Requirements

• Gradle 6.7 or higher

Configuration

URL

tasks.javadocLinks {
    urlProvider = { id -> "https://javadoc.io/doc/${id.group}/${id.name}/${id.version}/" }
}

Dependencies

configurations.javadocLinks {
    setExtendsFrom(listOf(configurations.apiElements.get()))
}