Book Image

Apache Maven Cookbook

Book Image

Apache Maven Cookbook

Overview of this book

Table of Contents (18 chapters)
Apache Maven Cookbook
About the Author
About the Reviewers

Generating source cross-reference for a site

In the previous chapter, we saw how the Maven JXR plugin generates source cross-reference. When publishing a project, it is useful to provide a way to refer to sources in addition to Javadocs. Let us see how to make that part of the site report.

How to do it...

Use the following steps to generate source cross-reference for a site:

  1. Open the Maven project project with documentation.

  2. Add the following code to the reporting section of the pom.xml file:

  3. Run the following command:

    mvn site
  4. Open the generated site report:

How it works...

Adding the Maven JXR plugin to the reporting section of pom automatically creates the project source cross-reference. By default, both source and test cross-references are generated. Like Javadoc, the reportSet element can be configured if we do not...