Make all plugin xdocs validate
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@292933 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
1 parent
8d86e6e568
commit
fe4a78733e
38 files changed
+101
-108
No files matched your search
@@ -24,19 +24,19 @@
|
||||
<author email="sgoeschl@apache.org">Siegfried Goeschl</author>
|
||||
</properties>
|
||||
<body>
|
||||
<section name = "Technical Background">
|
||||
<section name="Technical Background">
|
||||
<p>
|
||||
The Dashboard plugin aggregates report data from multiple Maven
|
||||
reports over multiple projects using the reactor. To
|
||||
understand the work of the plugin better we have to look at
|
||||
the following topics
|
||||
</p>
|
||||
<ul>
|
||||
<li>How to create the report data aggregate for a single project?</li>
|
||||
<li>How are the report data aggregate for the master project?</li>
|
||||
</ul>
|
||||
</p>
|
||||
</section>
|
||||
<section name = "Creating report data for a single project">
|
||||
<section name="Creating report data for a single project">
|
||||
<p>
|
||||
The aggregation runs over the existing Maven reports but how to
|
||||
get them?! Either the Dashboard plugin is told to collect data
|
||||
@@ -46,10 +46,10 @@
|
||||
</p>
|
||||
<p>
|
||||
This behaviour is controlled by
|
||||
</p>
|
||||
<source>
|
||||
maven.dashboard.rungoals = [true|false]
|
||||
</source>
|
||||
</p>
|
||||
<p>
|
||||
If this property is set to "true" the Dashboard plugin looks at
|
||||
the value of 'maven.dashboard.aggregators' to determine which
|
||||
@@ -58,20 +58,21 @@
|
||||
e.g. for the Clover plugin the XML report generation is enabled.
|
||||
</p>
|
||||
</section>
|
||||
<section name = "Aggregating data for the master project">
|
||||
<section name="Aggregating data for the master project">
|
||||
<p>
|
||||
The aggregation for the master project is a two-step process
|
||||
triggered by the reactor
|
||||
</p>
|
||||
<ul>
|
||||
<li>Aggregate the report data for a single project</li>
|
||||
<li>Aggregate the aggregated data over all projects</li>
|
||||
</ul>
|
||||
</p>
|
||||
<subsection name="Aggregate the report data for a single project">
|
||||
<p>
|
||||
The result of the aggregation is a file 'dashboard-single.xml'
|
||||
which could look like the following example collecting data of
|
||||
JUnit, Clover, PMD, CVS and Checkstyle reports
|
||||
</p>
|
||||
<source><![CDATA[
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
|
||||
@@ -84,7 +85,6 @@
|
||||
<aggregator name="cserrors">27</aggregator>
|
||||
</dashboard-single>
|
||||
]]></source>
|
||||
</p>
|
||||
</subsection>
|
||||
<subsection name="Aggregate the aggregated data over all projects">
|
||||
<p>
|
||||
@@ -92,6 +92,7 @@
|
||||
subprojects which results into a 'dashboard-data.xml'.
|
||||
This file is then transformed to the Dashoard HTML
|
||||
report.
|
||||
</p>
|
||||
<source><![CDATA[
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
|
||||
@@ -115,8 +116,7 @@
|
||||
</project>
|
||||
</dashboard>
|
||||
]]></source>
|
||||
</p>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
</document>
|
||||
Reference in new issue
Block a user