Cómo generar la documentación Javadoc con Gradle

Habiendo explicado qué es la herramienta Javadoc, y en otros artículos como crear taglets para incluirlos en los comentarios y generar contenido con los mecanismos de extensión que ofrece y explicado como cambiar los estilos que se usan por defecto en el Javadoc para por ejemplo cambiar los colores según la organización o incluir un texto de derechos de autor en el pie de página, hay que generar la documentación javadoc usando la herramienta de construcción que usemos. En este artículo muestro como generar la documentación javadoc con Gradle.

Lo primero es incluir en el proyecto el plugin de java. Con el plugin incluido se añade una tarea con la que generar la documentación javadoc.

1
2

$ ./gradlew javadoc

Para indicar en Gradle las opciones del comando javadoc hay que ver cuales son en las clases MinimalJavadocOptions, CoreJavadocOptions y StandardJavadocDocletOptions. Las opciones permiten indicar la clase de taglet propio y lo mismo para usar una hoja de estilos propia que puede estar basada pero con pequeñas modificaciones sobre la que usa javadoc por defecto, también para incluir un texto en cada página en el pie. Lo mismo sería para usar cualquiera de las otras opciones que tiene el comando javadoc. En el ejemplo se usan dos opciones para la codificación de caracteres.

1
2
3
4
5
6

apply plugin: 'java'

javadoc {
    options.charSet = 'UTF-8'
    options.encoding = 'UTF-8'
}

Para generar un artefacto con la documentación comprimida en un archivo zip hay que incluir la siguiente configuración en el archivo build.gradle.

1
2
3
4
5
6
7
8
9

task javadocArtifact(type: Zip) {
    dependsOn javadoc
    classifier 'javadoc'
    from 'build/docs/javadoc/'
}

artifacts {
    archives javadocArtifact
}

Con Gradle la documentación Javadoc se genera en el directorio build/xxx y el artefacto en el directorio build/xxx. Con las opciones anteriores este es el resultado del HTML generado.

El código fuente completo del ejemplo puedes descargarlo del repositorio de ejemplos de Blog Bitix alojado en GitHub y probarlo en tu equipo ejecutando siguiente comando:
./gradlew build