Skip to content

Commit

Permalink
Removed mergedJavadocs task
Browse files Browse the repository at this point in the history
  • Loading branch information
Rylern committed May 3, 2024
1 parent 3836039 commit 6c6abc0
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 49 deletions.
31 changes: 0 additions & 31 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -7,37 +7,6 @@ plugins {
// We don't want to generate javadocs for the root project
javadoc.enabled = false


// See https://discuss.gradle.org/t/best-approach-gradle-multi-module-project-generate-just-one-global-javadoc/18657
task mergedJavadocs(type: Javadoc,
description: 'Generate merged javadocs for all projects',
group: 'Documentation',
dependsOn: subprojects.tasks.collect {it.withType(Javadoc)} ) {

destinationDir = file("$buildDir/docs-merged/javadoc")
title = "QuPath $gradle.ext.qupathVersion"

// See https://docs.gradle.org/current/javadoc/org/gradle/external/javadoc/StandardJavadocDocletOptions.html
options.author(true)
options.addStringOption('Xdoclint:none', '-quiet')

options.encoding = 'UTF-8'

options.links "https://docs.oracle.com/en/java/javase/${libs.versions.jdk.get()}/docs/api/"
// Need to use the major version only with javafx
options.links "https://openjfx.io/javadoc/${libs.versions.javafx.get().split('\\.')[0]}/"
options.links "https://javadoc.io/doc/org.bytedeco/javacpp/${libs.versions.javacpp.get()}/"
options.links "https://javadoc.io/doc/org.bytedeco/opencv/${libs.versions.opencv.get()}/"
options.links "https://javadoc.io/doc/com.google.code.gson/gson/${libs.versions.gson.get()}/"
options.links "https://javadoc.io/doc/org.locationtech.jts/jts-core/${libs.versions.jts.get()}/"
options.links "https://javadoc.io/doc/net.imagej/ij/${libs.versions.imagej.get()}/"
options.links "https://javadoc.scijava.org/Bio-Formats/"
options.links "https://javadoc.io/doc/ai.djl/api/${libs.versions.deepJavaLibrary.get()}/"

// Don't fail on error, because this happened too often due to a javadoc link being temporarily down
failOnError = false
}

/*
* Get version catalog
*/
Expand Down
18 changes: 0 additions & 18 deletions qupath-app/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -106,20 +106,6 @@ dependencies {
implementation libs.picocli
}

/**
* Create a single javadoc jar
*/
task mergedJavadocJar(type: Jar, dependsOn: rootProject.tasks.mergedJavadocs) {
archiveFileName = "qupath-$qupathVersion-javadoc.jar"
destinationDirectory = rootProject.layout.buildDirectory.dir("docs-merged")
from rootProject.tasks.mergedJavadocs.destinationDir
}

/**
* Specify task dependencies
*/
jpackage.dependsOn(mergedJavadocJar)


/**
* Retrieve Javadocs of dependencies and sub-projects
Expand Down Expand Up @@ -222,10 +208,6 @@ distributions {
from this.rootProject.layout.buildDirectory.dir("reports/dependency-license")
include 'THIRD-PARTY.txt'
}
// Copy native libraries
into('lib/docs') {
from mergedJavadocJar.archiveFile
}
// Copy javadocs
into('lib/docs') {
from layout.buildDirectory.dir("javadocs")
Expand Down

0 comments on commit 6c6abc0

Please sign in to comment.