javadoc.gradle

/*
 * Copyright (c) 2011-2021 VMware Inc. or its affiliates, All Rights Reserved.
 *
 * 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
 *
 *   https://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 plugin: 'java-library'

javadoc {
    dependsOn jar
    group = 'documentation'
    description = 'Generates aggregated Javadoc API documentation.'

    title = "${project.name} $version"
    options.addStringOption('charSet', 'UTF-8')
    options.author = true
    options.header = "$project.name"

    options.memberLevel = JavadocMemberLevel.PROTECTED

    options.links([
            rootProject.jdkJavadoc,
            "https://javadoc.io/doc/com.badlogicgames.gdx/gdx-jnigen-loader/latest/"
    ] as String[])

    options.tags = ['apiNote:a:API Note:', 'implSpec:a:Implementation Requirements:',
                    'implNote:a:Implementation Note:']

    classpath += sourceSets.main.compileClasspath
}