Book Image

Apache Maven Cookbook

By : Raghuram Bharathan
Book Image

Apache Maven Cookbook

By: Raghuram Bharathan

Overview of this book

If you are a Java developer or a manager who has experience with Apache Maven and want to extend your knowledge, then this is the ideal book for you. Apache Maven Cookbook is for those who want to learn how Apache Maven can be used for build automation. It is also meant for those familiar with Apache Maven, but want to understand the finer nuances of Maven and solve specific problems.
Table of Contents (13 chapters)
12
Index

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:

    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-jxr-plugin</artifactId>
      <version>2.5</version>
    </plugin>
  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...