Revision c31197048c10a9f021637ca1b7ba828ac0fd962d authored by tianyifeng on 11 August 2023, 16:49:24 UTC, committed by Tianyi Feng on 14 August 2023, 10:23:08 UTC
PiperOrigin-RevId: 555987303 (cherry picked from commit 0a62b342fc48173def9bc416b91c1fa83e7ec5ce)
1 parent 48c3b3e
javadoc_combined.gradle
// 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
![swh spinner](/static/img/swh-spinner.gif)
Computing file changes ...