Maven Projects

ASF

Maven JXR Plugin

The JXR Plugin produces a cross-reference of the project's sources. The generated reports make it easier for the user to reference or find specific lines of code. It is also handy when used with the PMD Plugin for referencing errors found in the code.

Goals Overview

The JXR Plugin has 4 goals:

jxr:jxr is used to generate a cross-reference page of the project's main sources. The generated JXR files can be linked to the javadocs of the project.

jxr:aggregate is used to generate an aggregated cross-reference page of the project's main sources. The generated JXR files can be linked to the javadocs of the project.

jxr:test-jxr on the other hand, is used to generate a cross-reference page of the project's test sources.

jxr:test-aggregate on the other hand, is used to generate an aggregated cross-reference page of the project's test sources.

Usage

General instructions on how to use the JXR Plugin can be found on the usage page. Some more specific use cases are described in the examples given below. Last but not least, users occasionally contribute additional examples, tips or errata to the plugin's wiki page.

In case you still have questions regarding the plugin's usage, please have a look at the FAQ and feel free to contact the user mailing list. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the mail archive.

If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our issue tracker. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our source repository and will find supplementary information in the guide to helping with Maven.

Examples

To provide you with better understanding on some usages of the JXR Plugin, you can take a look into the following examples: