gradle build with javadoc

https://w‮ual.ww‬tturi.com
gradle build with javadoc

To generate Javadoc documentation for a Gradle project, you can use the javadoc task provided by the Java plugin.

Here's an example of how you can configure the javadoc task in your Gradle build file:

apply plugin: 'java'

// Other build configuration

task javadocs(type: Javadoc) {
  source = sourceSets.main.allJava
  classpath += sourceSets.main.compileClasspath
  destinationDir = file("$buildDir/javadocs")
  options.windowTitle = 'My Project Javadoc'
  options.memberLevel = JavadocMemberLevel.PROTECTED
  options.addStringOption("Xdoclint:none", "-quiet")
}

This configuration will generate Javadoc documentation for all the Java source files in the main source set, and will include protected members in the documentation. The documentation will be generated in the build/javadocs directory.

To generate the Javadoc documentation, you can then run the javadocs task from the command line:

gradle javadocs

You can also specify additional options for the javadoc task, such as the package names to include or exclude, the doclet to use, and the stylesheet to use for the generated documentation.

For more information about the javadoc task and the options that it supports, you can refer to the Gradle documentation for the Java plugin.

Created Time:2017-11-01 12:05:01  Author:lautturi