maven-plugins/xdoc/src/plugin-resources/templates/maven-reports.xml

<?xml version="1.0"?>
<document>

  <properties>
    <title>Project Reports</title>
    <author email="pete-apache-dev@kazmier.com">Pete Kazmier</author>
  </properties>

  <body>
    <section name="Maven Generated Reports">
      <p>
        This document provides an overview of the various reports that
        are automatically generated by 
        <a href="http://jakarta.apache.org/turbine/maven/">Maven</a>.
        Each report is briefly described below.
      </p>

      <subsection name="Overview">
        <table>
          <tr><th>Document</th><th>Description</th></tr>
          #if (! $project.reports.isEmpty())
            #foreach ($report in $reports)
            <tr>
              <td><a href="${report.link}.html">$report.name</a></td>
              <td>$report.description</td>
            </tr>
            #end
          #else
            <tr><td><a href="changes.html">Changes</a></td>
              <td>
                This document provides a history of the changes made to the
                project, in a user friendly format, generated from the
                xdocs/changes.xml file.
              </td>
            </tr>
            #if ($project.repository)
            <tr><td><a href="changelog-report.html">Change Log</a></td>
              <td>
                This document provides a history of the most recent
                changes made to the project taken directly from the
                source code repository.
              </td>
            </tr>
            <tr><td><a href="developer-activity-report.html">Developer Activity</a></td>
              <td>
                This document provides a report of activity in terms of
                CVS commits and breaks it out by developer.
              </td>
            </tr>
            <tr><td><a href="file-activity-report.html">File Activity</a></td>
              <td>
                This document provides a report of activity in terms of
                CVS commits and breaks it out by file.
              </td>
            </tr>
            #end
            <tr><td><a href="tasks.html">Tasks</a></td>
              <td>
                This document provides a list of tasks that need to
                be completed for the project, generated from the
                xdocs/tasks.xml file.
              </td>
            </tr>
            <tr><td><a href="task-list.html">Task List</a></td>
              <td>
                This document provides a list of tasks that need to
                be completed for the project, generated from the
                @task javadoc tag in java source code.
              </td>
            </tr>
            #if ($files.file($project.build.unitTestSourceDirectory).exists())
            <tr><td><a href="junit-report.html">Unit Tests</a></td>
              <td>
                This document provides the results of the unit tests that
                are part of this project.  Successes and failures are
                noted.
              </td>
            </tr>
            #end
            
            #if ($files.file($project.build.sourceDirectory).exists())
            <tr><td><a href="jdepend-report.html">Metric Results</a></td>
              <td>
                This document provides information on various source code
                metrics that have been computed.  These metrics can
                provide useful information regarding the abstractness and
                total number of classes.
              </td>
            </tr>
            <tr><td><a href="checkstyle-report.html">Checkstyle Report</a></td>
              <td>
                This document provides the results of the Checkstyle
                report.  This report provides an indication of how well
                this project complies with its coding conventions.
              </td>
            </tr>
            <tr><td><a href="javadoc.html">Javadoc Report</a></td>
              <td>
                This document the details of javadoc execution against
                the project. This encourages the reduction of javadoc
                errors.
              </td>
            </tr>
            #end
            
            #if ($files.file("$maven-docs-dest/clover").exists())
            <tr><td><a href="clover/index.html">Clover Test Coverage</a></td>
              <td>
                This document provides the results of the Clover report. This
                reports show what portion on your code has been executed by
                your test suite and generates statistics. It gives a very good
                idea of how good your test suite is.
              </td>
            </tr>
            #end
            #if ($files.file("$gen-xdocs/cactus-report.xml").exists())
            <tr><td><a href="cactus-report.html">Cactus Tests</a></td>
              <td>
                This document provides the results of the Cactus unit tests that
                are part of this project.  Successes and failures are noted.
              </td>
            </tr>
            #end
          #end
        </table>
      </subsection>
    </section>
 </body>
</document>