mirror of https://github.com/apache/lucene.git
39 lines
1.6 KiB
Groovy
39 lines
1.6 KiB
Groovy
|
// Configure javadoc defaults.
|
||
|
|
|
||
|
|
allprojects {
|
||
|
|
plugins.withType(JavaPlugin) {
|
||
|
|
tasks.matching { it.name == "javadoc" }.all {
|
||
|
|
StandardJavadocDocletOptions opts = (options as StandardJavadocDocletOptions)
|
||
|
|
opts.locale("en_US")
|
||
|
|
opts.charSet = "UTF-8"
|
||
|
|
opts.encoding = "UTF-8"
|
||
|
|
opts.docEncoding = "UTF-8"
|
||
|
|
|
||
|
|
opts.noIndex()
|
||
|
|
opts.memberLevel = JavadocMemberLevel.PROTECTED
|
||
|
|
opts.version = true
|
||
|
|
opts.author = true
|
||
|
|
opts.use = true
|
||
|
|
|
||
|
|
opts.linksOffline(
|
||
|
|
"https://docs.oracle.com/en/java/javase/11/docs/api/",
|
||
|
|
project(":lucene").file("tools/javadoc/java11/").toString())
|
||
|
|
|
||
|
|
opts.tags(
|
||
|
|
"lucene.experimental:a:WARNING: This API is experimental and might change in incompatible ways in the next release.",
|
||
|
|
"lucene.internal:a:NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.",
|
||
|
|
"lucene.spi:t:SPI Name (Note: This is case-insensitive. e.g., if the name is 'htmlStrip', 'htmlstrip' can be used when looking up the service).",
|
||
|
|
)
|
||
|
|
|
||
|
|
opts.addStringOption("-release", "11")
|
||
|
|
opts.addBooleanOption('Xdoclint:all,-accessibility,-missing,-html,-syntax', true)
|
||
|
|
|
||
|
|
def libName = project.path.startsWith(":lucene") ? "Lucene" : "Solr"
|
||
|
|
opts.overview = file("src/main/java/overview.html").toString()
|
||
|
|
opts.docTitle = "${libName} ${project.version} ${project.name} API"
|
||
|
|
opts.windowTitle = "${libName} ${project.version} ${project.name} API"
|
||
|
|
opts.bottom = "<i>Copyright © 2000-${buildYear} Apache Software Foundation. All Rights Reserved.</i>"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|