o Consolidate reporting model
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@112978 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
bwalding
@@ -206,127 +206,41 @@
|
||||
<small>
|
||||
<a href="${relativePath}/maven-reports.html">Project Reports</a>
|
||||
</small>
|
||||
<j:choose>
|
||||
<j:when test="${!pom.reports.isEmpty()}">
|
||||
<!--
|
||||
| Check to see if we need to include the report
|
||||
| links in this document. The only time we
|
||||
| need to do this is when the current document
|
||||
| either the maven-reports.xml doc (the page
|
||||
| is displayed when clicking on Project
|
||||
| Reports) or when the current document is one
|
||||
| of the actual reports (in which case we want
|
||||
| to leave the project report links expanded.
|
||||
|-->
|
||||
<j:set var="includeReportLinks" value="false"/>
|
||||
<j:forEach var="report" items="${reports}">
|
||||
<j:set var="linkWithXmlExt" value="${report.link}.xml"/>
|
||||
<j:if test="${relativePath == '.' and (fileName.endsWith('maven-reports.xml') or fileName.endsWith(linkWithXmlExt))}">
|
||||
<j:set var="includeReportLinks" value="true"/>
|
||||
</j:if>
|
||||
</j:forEach>
|
||||
<!--
|
||||
| If we need to include the report links, then
|
||||
| do so. This is determined by the above
|
||||
| block.
|
||||
|-->
|
||||
<j:if test="${includeReportLinks == 'true'}">
|
||||
<j:forEach var="report" items="${reports}">
|
||||
<div>
|
||||
<small>
|
||||
<a href="${relativePath}/${report.link}.html">
|
||||
${report.name}
|
||||
</a>
|
||||
</small>
|
||||
</div>
|
||||
</j:forEach>
|
||||
</j:if>
|
||||
</j:when>
|
||||
<j:otherwise>
|
||||
<!-- The old static method -->
|
||||
<util:tokenize var="projectReportFiles" delim=",">${maven.xdoc.projectReports}</util:tokenize>
|
||||
<j:forEach var="reportFile" items="${projectReportFiles}">
|
||||
<j:if test="${relativePath == '.' and fileName.endsWith(reportFile.trim())}">
|
||||
<util:available file="${maven.docs.src}/tasks.xml">
|
||||
<div>
|
||||
<small>
|
||||
<a href="${relativePath}/tasks.html">Tasks</a>
|
||||
</small>
|
||||
</div>
|
||||
</util:available>
|
||||
<util:available file="${maven.gen.docs}/task-list.xml">
|
||||
<div>
|
||||
<small>
|
||||
<a href="${relativePath}/task-list.html">Task List</a>
|
||||
</small>
|
||||
</div>
|
||||
</util:available>
|
||||
<util:available file="${maven.docs.src}/changes.xml">
|
||||
<div>
|
||||
<small>
|
||||
<a href="${relativePath}/changes.html">Changes</a>
|
||||
</small>
|
||||
</div>
|
||||
</util:available>
|
||||
<j:if test="${!empty(pom.repository.connection)}">
|
||||
<div>
|
||||
<small>
|
||||
<a href="${relativePath}/changelog-report.html">Change Log</a>
|
||||
</small>
|
||||
</div>
|
||||
<div>
|
||||
<small>
|
||||
<a href="${relativePath}/developer-activity-report.html">Developer Activity</a>
|
||||
</small>
|
||||
</div>
|
||||
<div>
|
||||
<small>
|
||||
<a href="${relativePath}/file-activity-report.html">File Activity</a>
|
||||
</small>
|
||||
</div>
|
||||
</j:if>
|
||||
<j:if test="${unitTestSourcesPresent}">
|
||||
<div>
|
||||
<small>
|
||||
<a href="${relativePath}/junit-report.html">Unit Tests</a>
|
||||
</small>
|
||||
</div>
|
||||
</j:if>
|
||||
<j:if test="${sourcesPresent}">
|
||||
<div>
|
||||
<small>
|
||||
<a href="${relativePath}/jdepend-report.html">Metric Results</a>
|
||||
</small>
|
||||
</div>
|
||||
<div>
|
||||
<small>
|
||||
<a href="${relativePath}/checkstyle-report.html">Checkstyle Report</a>
|
||||
</small>
|
||||
</div>
|
||||
<div>
|
||||
<small>
|
||||
<a href="${relativePath}/javadoc.html">Javadoc Report</a>
|
||||
</small>
|
||||
</div>
|
||||
</j:if>
|
||||
<util:available file="${maven.docs.dest}/clover">
|
||||
<div>
|
||||
<small>
|
||||
<a href="${relativePath}/clover/index.html">Clover Test Coverage</a>
|
||||
</small>
|
||||
</div>
|
||||
</util:available>
|
||||
<util:available file="${maven.gen.docs}/cactus-report.xml">
|
||||
<div>
|
||||
<small>
|
||||
<a href="${relativePath}/cactus-report.html">Cactus Tests</a>
|
||||
</small>
|
||||
</div>
|
||||
</util:available>
|
||||
</j:if>
|
||||
</j:forEach>
|
||||
</j:otherwise>
|
||||
</j:choose>
|
||||
|
||||
<!--
|
||||
| Check to see if we need to include the report
|
||||
| links in this document. The only time we
|
||||
| need to do this is when the current document
|
||||
| either the maven-reports.xml doc (the page
|
||||
| is displayed when clicking on Project
|
||||
| Reports) or when the current document is one
|
||||
| of the actual reports (in which case we want
|
||||
| to leave the project report links expanded.
|
||||
|-->
|
||||
<j:set var="includeReportLinks" value="false"/>
|
||||
<j:forEach var="report" items="${reports}">
|
||||
<j:set var="linkWithXmlExt" value="${report.link}.xml"/>
|
||||
<j:if test="${relativePath == '.' and (fileName.endsWith('maven-reports.xml') or fileName.endsWith(linkWithXmlExt))}">
|
||||
<j:set var="includeReportLinks" value="true"/>
|
||||
</j:if>
|
||||
</j:forEach>
|
||||
|
||||
<!--
|
||||
| If we need to include the report links, then
|
||||
| do so. This is determined by the above
|
||||
| block.
|
||||
|-->
|
||||
<j:if test="${includeReportLinks == 'true'}">
|
||||
<j:forEach var="report" items="${reports}">
|
||||
<div>
|
||||
<small>
|
||||
<a href="${relativePath}/${report.link}.html">
|
||||
${report.name}
|
||||
</a>
|
||||
</small>
|
||||
</div>
|
||||
</j:forEach>
|
||||
</j:if>
|
||||
</div>
|
||||
<j:if test="${pom.reports.isEmpty()}">
|
||||
<j:if test="${sourcesPresent}">
|
||||
|
||||
@@ -15,116 +15,15 @@
|
||||
Each report is briefly described below.
|
||||
</p>
|
||||
|
||||
<subsection name="Overview">
|
||||
#set ($reports = $project.getPluginContext('maven-xdoc-plugin').getVariable('reports'))
|
||||
<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
|
||||
#if ($files.file("$maven-docs-dest/changes.html").exists())
|
||||
<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>
|
||||
#end
|
||||
#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
|
||||
#if ($files.file("$maven-docs-dest/task.html").exists())
|
||||
<tr><td><a href="task.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>
|
||||
#end
|
||||
<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
|
||||
@todo 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
|
||||
#foreach ($report in $reports)
|
||||
<tr>
|
||||
<td><a href="${report.link}.html">$report.name</a></td>
|
||||
<td>$report.description</td>
|
||||
</tr>
|
||||
#end
|
||||
</table>
|
||||
</subsection>
|
||||
|
||||
Reference in New Issue
Block a user