80805b074a
This flag was introduced to fix links in javadoc search when generating it with Java 11: <unknown commit> The flag is no longer supported with Java 17 (which is required for Gradle 8.0+), and seems to no longer be needed: I generated the javadoc with it removed and the search links work OK. PiperOrigin-RevId: 536738686
95 lines
3.7 KiB
Groovy
95 lines
3.7 KiB
Groovy
// Copyright (C) 2017 The Android Open Source Project
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
apply from: "${buildscript.sourceFile.parentFile}/constants.gradle"
|
|
apply from: "${buildscript.sourceFile.parentFile}/javadoc_util.gradle"
|
|
|
|
class CombinedJavadocPlugin implements Plugin<Project> {
|
|
|
|
static final String JAVADOC_TASK_NAME = "generateCombinedJavadoc"
|
|
|
|
@Override
|
|
void apply(Project project) {
|
|
project.gradle.projectsEvaluated {
|
|
Set<Project> libraryModules = getLibraryModules(project)
|
|
if (!libraryModules.isEmpty()) {
|
|
def guavaReferenceUrl = "https://guava.dev/releases/$project.ext.guavaVersion/api/docs"
|
|
|
|
project.task(JAVADOC_TASK_NAME, type: Javadoc) {
|
|
description = "Generates combined Javadoc."
|
|
title = "ExoPlayer library"
|
|
source = libraryModules.generateJavadoc.source
|
|
classpath = project.files([])
|
|
destinationDir = project.file("$project.buildDir/docs/javadoc")
|
|
options {
|
|
links "https://developer.android.com/reference", guavaReferenceUrl
|
|
encoding = "UTF-8"
|
|
}
|
|
exclude "**/BuildConfig.java"
|
|
exclude "**/R.java"
|
|
doFirst {
|
|
libraryModules.each { libraryModule ->
|
|
libraryModule.android.libraryVariants.all { variant ->
|
|
def name = variant.buildType.name
|
|
if (name == "release") {
|
|
// Works around b/234569640 that causes different versions of the androidx.media
|
|
// jar to be on the classpath.
|
|
def allJarFiles = []
|
|
allJarFiles.addAll(variant.javaCompileProvider.get().classpath.files)
|
|
def filteredJarFiles = allJarFiles.findAll { file ->
|
|
if (file ==~ /.*media-.\..\..-api.jar$/
|
|
&& !file.path.endsWith(
|
|
"media-" + project.ext.androidxMediaVersion + "-api.jar")) {
|
|
return false;
|
|
}
|
|
if (file ==~ /.*\/core-.\..\..-api.jar$/
|
|
&& !file.path.endsWith(
|
|
"core-" + project.ext.androidxCoreVersion + "-api.jar")) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
classpath +=
|
|
libraryModule.project.files(
|
|
filteredJarFiles,
|
|
libraryModule.project.android.getBootClasspath())
|
|
}
|
|
}
|
|
}
|
|
}
|
|
doLast {
|
|
libraryModules.each { libraryModule ->
|
|
project.copy {
|
|
from "${libraryModule.projectDir}/src/main/javadoc"
|
|
into "${project.buildDir}/docs/javadoc"
|
|
}
|
|
}
|
|
project.fixJavadoc()
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Returns Android library modules that declare a generateJavadoc task.
|
|
private static Set<Project> getLibraryModules(Project project) {
|
|
project.subprojects.findAll {
|
|
it.plugins.findPlugin("com.android.library") &&
|
|
it.tasks.findByName("generateJavadoc")
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
apply plugin: CombinedJavadocPlugin
|