mirror of
https://github.com/apache/lucene.git
synced 2025-02-08 11:05:29 +00:00
f41eabdc5f
Java 13 adds a new doclint check under "accessibility" that the html header nesting level isn't crazy. Many are incorrect because the html4-style javadocs had horrible font-sizes, so developers used the wrong header level to work around it. This is no issue in trunk (always html5). Java recommends against using such structured tags at all in javadocs, but that is a more involved change: this just "shifts" header levels in documents to be correct.
78 lines
2.8 KiB
Groovy
78 lines
2.8 KiB
Groovy
/*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright ownership.
|
|
* The ASF licenses this file to You 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.
|
|
*/
|
|
|
|
// Configure javadoc defaults.
|
|
|
|
allprojects {
|
|
plugins.withType(JavaPlugin) {
|
|
tasks.matching { it.name == "javadoc" }.all {
|
|
StandardJavadocDocletOptions opts = (options as StandardJavadocDocletOptions)
|
|
opts.locale("en_US")
|
|
opts.setJFlags(["-Duser.language=en", "-Duser.country=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 (case-insensitive: if the name is 'htmlStrip', 'htmlstrip' can be used when looking up the service).",
|
|
)
|
|
|
|
opts.addStringOption("-release", "11")
|
|
opts.addBooleanOption('Xdoclint:all,-missing', true)
|
|
|
|
def libName = project.path.startsWith(":lucene") ? "Lucene" : "Solr"
|
|
opts.overview = file("src/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>"
|
|
}
|
|
}
|
|
}
|
|
|
|
// https://issues.apache.org/jira/browse/LUCENE-9132: Add apache yetus so that javadoc doesn't fail
|
|
configure([
|
|
project(":solr:solrj"),
|
|
project(":solr:core"),
|
|
project(":solr:test-framework"),
|
|
]) {
|
|
configurations {
|
|
javadocFix
|
|
}
|
|
|
|
dependencies {
|
|
javadocFix("org.apache.yetus:audience-annotations:0.11.1")
|
|
}
|
|
|
|
plugins.withType(JavaPlugin) {
|
|
javadoc {
|
|
classpath += configurations.javadocFix.asFileTree
|
|
}
|
|
}
|
|
}
|