Apache Maven JXR (Plugin)

Clone this repo:
  1. 825ccf5 Document the Maven 3.9.0 prerequisite by Sylwester Lachiewicz · 13 hours ago master
  2. 5544611 Refresh the site documentation and README by Sylwester Lachiewicz · 21 hours ago
  3. 7c4e5fa Require Maven 3.9.0 by Sylwester Lachiewicz · 20 hours ago
  4. 5dbdfe1 Fix the stray brace in the no-fork goal descriptions by Sylwester Lachiewicz · 21 hours ago
  5. c87068e Use JUnit 5 assertions and Mockito best practices in tests by Sylwester Lachiewicz · 2 days ago

Apache Maven JXR

Apache License, Version 2.0, January 2004 Maven Central Reproducible Builds Verify

JXR (Java Cross Reference) renders Java source files as linked HTML pages: one page per file, an anchor on every line, and links from each type name to its definition and to its Javadoc. Report plugins such as PMD and Checkstyle link their findings to these pages.

This repository holds two modules:

ModuleArtifactRole
maven-jxrorg.apache.maven:maven-jxrThe library that parses the sources and writes the HTML
maven-jxr-pluginorg.apache.maven.plugins:maven-jxr-pluginThe report plugin (jxr:jxr, jxr:aggregate and others) for the Maven site

Both need Java 8 or later; the plugin needs Maven 3.9.0 or later.

Build

mvn verify

Run the plugin's integration tests (in maven-jxr-plugin/src/it) with:

mvn -Prun-its verify

Build the site, including this project's own cross-reference and Javadoc, with:

mvn install -DskipTests
mvn site site:stage -Preporting

The staged site is in target/staging.

Contributing

Open an issue before a larger change, and a pull request against master. Run mvn -Prun-its verify before you push; the build checks formatting with Spotless (mvn spotless:apply fixes it) and license headers with Apache RAT. Contributions are licensed under the Apache License 2.0; regular contributors should file an Individual Contributor License Agreement.