README.adoc

Table of Contents

• Gradle JXR plugin
• Compatibility
• Installation
  • Gradle 3+
  • Gradle up to 2.x
• Usage
• License
• Alternatives
• Credits
• TODO
• Release Notes
  • v0.2.1
  • v0.2.0
  • v0.1.1
  • v0.1

Gradle JXR plugin

Compatibility

Please note the plugin has been slightly adapted to support Gradle 3. Moreover from version 0.2.x the published artifacts have also moved from jcenter to the new Gradle Plugin Portal.

Table 1. Gradle compatibility

Gradle version	Plugin version
>= 3.x	0.2.x
⇐ 2.x	0.1.x

Installation

Apply the plugin in a java project as follows

Gradle 3+

plugins {
  id "net.davidecavestro.gradle.jxr" version "0.2.1"
}

Gradle up to 2.x

buildscript {
    repositories {
        mavenRepo name: 'Bintray', url: 'http://jcenter.bintray.com'
        mavenCentral()
    }

    dependencies {
        classpath 'net.davidecavestro:gradle-jxr-plugin:0.1.1'
    }
}

apply plugin: 'java'
apply plugin: 'jxr'

Usage

Once installed the plugin provides the additional task jxr. It produces per-project html crossreference files for your java sources at path build/jxr.

License

The gradle JXR plugin is licensed under the Apache License, Version 2.0.

Alternatives

The JXR-Ant project provides an ANT task with some examples for using it within a gradle project.

Credits

Many thanks to:

• The Gradle project

• The Maven project

• The asciidoctor-gradle-plugin (I learned very much from their code).

• Baron Roberts for adding support to Gradle 3

TODO

• find a way to fix missing cross references when using whitespaces before or after method/constructor declaration.

• add support for aggregating references

• add support for multiproject builds

• add support for linking javadoc

• add support for generating xrefs for groovy sources

• add configuration hooks for JXR configuration, namely: input/output encoding, source dirs, output dir

• documentation

Release Notes

v0.2.1

• Added support to Gradle 3

v0.2.0

• BROKEN do not use it

v0.1.1

• Added sources jar to published artifacts (in order to be published at http://jcenter.bintray.com).

v0.1

• Initial release. Very rough support in place.