xref: /aosp_15_r20/external/doclava/Android.bp (revision feeed43c7c55e85932c547a3cefc559df175227c)

// Copyright (C) 2018 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.

package {
    default_applicable_licenses: ["external_doclava_license"],
}

// Added automatically by a large-scale-change that took the approach of
// 'apply every license found to every target'. While this makes sure we respect
// every license restriction, it may not be entirely correct.
//
// e.g. GPL in an MIT project might only apply to the contrib/ directory.
//
// Please consider splitting the single license below into multiple licenses,
// taking care not to lose any license_kind information, and overriding the
// default license using the 'licenses: [...]' property on targets as needed.
//
// For unused files, consider creating a 'fileGroup' with "//visibility:private"
// to attach the license to, and including a comment whether the files may be
// used in the current project.
// See: http://go/android-license-faq
license {
    name: "external_doclava_license",
    visibility: [":__subpackages__"],
    license_kinds: [
        "SPDX-license-identifier-Apache-2.0",
        "SPDX-license-identifier-BSD",
        "SPDX-license-identifier-CC-BY",
        "SPDX-license-identifier-GPL",
        "SPDX-license-identifier-GPL-2.0",
        "SPDX-license-identifier-GPL-2.0-with-classpath-exception",
        "SPDX-license-identifier-LGPL",
        "SPDX-license-identifier-MIT",
    ],
    license_text: [
        "NOTICE",
    ],
}

droiddoc_exported_dir {
    name: "droiddoc-templates-sdk",
    path: "res/assets/templates-sdk",
}

java_defaults {
    name: "doclava_defaults",
    java_resource_dirs: ["res"],
    errorprone: {
        javacflags: [
            "-Xep:FormatString:WARN",
            "-Xep:ComparableType:WARN",
            "-Xep:ReturnValueIgnored:WARN",
        ],
    },
    static_libs: [
        "jsilver",
        "antlr-runtime",
        "tagsoup",
        "doclava-doclet-adapter",
    ],
}

java_library_host {
    name: "doclava-doclet-adapter",
    srcs: [
        "doclet_adapter/src/main/java/**/*.java",
    ],
    libs: [
        "guava",
    ],
    javacflags: [
        "--add-modules=jdk.compiler",
        "--add-exports jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED",
        "--add-exports jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED",
        "--add-exports jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED",
        "--add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED",
        "--add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED",
        "--add-modules=jdk.javadoc",
        "--add-exports jdk.javadoc/jdk.javadoc.internal.doclets.formats.html=ALL-UNNAMED",
        "--add-exports jdk.javadoc/jdk.javadoc.internal.tool=ALL-UNNAMED",
    ],
    errorprone: {
        javacflags: [
            "-Xep:ComparableType:WARN",
        ],
    },
}

java_library_host {
    name: "doclava",
    defaults: ["doclava_defaults"],
    srcs: [
        "src/com/google/doclava/**/*.java",
    ],
    static_libs: [
        "guava",
    ],
}


// TODO: add a test target.
// For now, you can run the unit tests thus:
// vogar --classpath /usr/lib/jvm/java-6-sun/lib/tools.jar --classpath ../../out/host/common/obj/JAVA_LIBRARIES/antlr_intermediates/javalib.jar --sourcepath src/ --sourcepath ../jsilver/src/ --mode jvm test/doclava/ApiCheckTest.java