Skip to content
apachePublic

Latest commit

 

History

497 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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:

Module Artifact Role
maven-jxr org.apache.maven:maven-jxr The library that parses the sources and writes the HTML
maven-jxr-plugin org.apache.maven.plugins:maven-jxr-plugin The 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.

Releases

Packages

Used by

Contributors

Languages