You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2010/01/20 14:26:27 UTC
svn commit: r901187 - in /maven/jxr/trunk/maven-jxr-plugin/src/site:
apt/examples/aggregate.apt.vm apt/examples/include-exclude.apt.vm
apt/examples/linkjavadoc.apt.vm apt/index.apt apt/usage.apt.vm site.xml
Author: dennisl
Date: Wed Jan 20 13:26:26 2010
New Revision: 901187
URL: http://svn.apache.org/viewvc?rev=901187&view=rev
Log:
o Improve the plugin site.
Modified:
maven/jxr/trunk/maven-jxr-plugin/src/site/apt/examples/aggregate.apt.vm
maven/jxr/trunk/maven-jxr-plugin/src/site/apt/examples/include-exclude.apt.vm
maven/jxr/trunk/maven-jxr-plugin/src/site/apt/examples/linkjavadoc.apt.vm
maven/jxr/trunk/maven-jxr-plugin/src/site/apt/index.apt
maven/jxr/trunk/maven-jxr-plugin/src/site/apt/usage.apt.vm
maven/jxr/trunk/maven-jxr-plugin/src/site/site.xml
Modified: maven/jxr/trunk/maven-jxr-plugin/src/site/apt/examples/aggregate.apt.vm
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr-plugin/src/site/apt/examples/aggregate.apt.vm?rev=901187&r1=901186&r2=901187&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr-plugin/src/site/apt/examples/aggregate.apt.vm (original)
+++ maven/jxr/trunk/maven-jxr-plugin/src/site/apt/examples/aggregate.apt.vm Wed Jan 20 13:26:26 2010
@@ -1,9 +1,9 @@
------
- Aggregating JXR Reports for Multi-Projects
+ Aggregating JXR Reports for Multi-module Projects
------
Maria Odea Ching
------
- 5 July 2006
+ 2010-01-20
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -24,10 +24,10 @@
~~ under the License.
-Aggregating JXR Reports for Multi-Projects
+Aggregating JXR Reports for Multi-module Projects
- The <<<aggregate>>> parameter of the JXR plugin can be used to generate JXR files for multi-module projects. Using this parameter,
- you can opt to generate 1 compiled set of JXR files for the whole project (all modules) or generate 1 set of JXR files for
+ The <<<aggregate>>> parameter of the JXR Plugin can be used to generate JXR files for multi-module projects. Using this parameter,
+ you can opt to generate one compiled set of JXR files for the whole project (all modules) or generate one set of JXR files for
each module.
For example, you have the following directory structure:
@@ -64,7 +64,7 @@
`-- pom.xml
+-----+
- And you have the following configuration in your pom.xml:
+ And you have the following configuration in your <<<pom.xml>>>:
+-----+
<project>
@@ -88,8 +88,7 @@
</project>
+-----+
- When you execute <<<mvn site:site>>> from the parent directory, which is Project, a set of JXR files will be created
- in the target directory of Project where all of the JXR files of the project's submodules are included. Otherwise if
- the <<<aggregate>>> parameter is set to false, a set of JXR files for Module1 will be generated in the target directory of
- Module1, another set of JXR files for Module2 will be generated in the target directory of Module2, and so on.
-
+ When you execute <<<mvn site>>> from the parent directory, which is <Project>, a set of JXR files will be created
+ in the target directory of <Project> where all of the JXR files of the project's submodules are included. Otherwise if
+ the <<<aggregate>>> parameter is set to <<<false>>>, a set of JXR files for <Module1> will be generated in the target directory of
+ <Module1>, another set of JXR files for <Module2> will be generated in the target directory of <Module2>, and so on.
Modified: maven/jxr/trunk/maven-jxr-plugin/src/site/apt/examples/include-exclude.apt.vm
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr-plugin/src/site/apt/examples/include-exclude.apt.vm?rev=901187&r1=901186&r2=901187&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr-plugin/src/site/apt/examples/include-exclude.apt.vm (original)
+++ maven/jxr/trunk/maven-jxr-plugin/src/site/apt/examples/include-exclude.apt.vm Wed Jan 20 13:26:26 2010
@@ -3,7 +3,7 @@
------
Dennis Lundberg
------
- 2 March 2007
+ 2010-01-20
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -27,14 +27,14 @@
Including/Excluding Source Files
To include or exclude files from the generated JXR files, you need to
- configure the JXR plugin in your <<<pom.xml>>>. This is done using patterns
+ configure the JXR Plugin in your <<<pom.xml>>>. This is done using patterns
similar to those used in Ant.
*Including files
The default is to include all java files. The pattern <<<**/*.java>>> is used
to achieve this. If you want to use a different pattern you just configure it
- in your pom.xml like this:
+ in your <<<pom.xml>>> like this:
+-----+
<project>
@@ -64,7 +64,7 @@
*Excluding files
By default no files are excluded. You can exclude files by configuring your
- pom.xml. If you want to exclude all your abstract classes a configuration
+ <<<pom.xml>>>. If you want to exclude all your abstract classes a configuration
like this might be useful:
+-----+
Modified: maven/jxr/trunk/maven-jxr-plugin/src/site/apt/examples/linkjavadoc.apt.vm
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr-plugin/src/site/apt/examples/linkjavadoc.apt.vm?rev=901187&r1=901186&r2=901187&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr-plugin/src/site/apt/examples/linkjavadoc.apt.vm (original)
+++ maven/jxr/trunk/maven-jxr-plugin/src/site/apt/examples/linkjavadoc.apt.vm Wed Jan 20 13:26:26 2010
@@ -3,7 +3,7 @@
------
Maria Odea Ching
------
- 6 July 2006
+ 2010-01-20
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -26,7 +26,7 @@
Linking JXR Files to Javadocs
- To link the generated JXR files to the javadocs, you need to set the following JXR plugin configuration in your pom.xml:
+ To link the generated JXR files to the Javadocs, you need to set the following JXR Plugin configuration in your <<<pom.xml>>>:
+-----+
<project>
@@ -52,10 +52,10 @@
</project>
+-----+
- The generated JXR pages will have a link named "View Javadoc" that will display the javadoc of the class. In case there
- were no existing javadocs in the specified javadoc directory and no javadocs will be generated (meaning no javadoc plugin
- configuration in the reporting section of the pom), the link will no longer be displayed even if the <<<linkJavadoc>>> parameter
- is set to true.
+ The generated JXR pages will have a link named "View Javadoc" that will display the Javadoc of the class. In case there
+ were no existing Javadocs in the specified Javadoc directory and no Javadocs will be generated (meaning no Javadoc Plugin
+ configuration in the reporting section of the POM), the link will not be displayed even if the <<<linkJavadoc>>> parameter
+ is set to <<<true>>>.
- Take note that if the <<<destDir>>> parameter is set in the javadoc plugin configuration, you need to also set the <<<javadocDir>>>
- parameter of the JXR plugin to the same directory.
\ No newline at end of file
+ Take note that if the <<<destDir>>> parameter is set in the Javadoc Plugin configuration, you need to also set the <<<javadocDir>>>
+ parameter of the JXR Plugin to the same directory.
Modified: maven/jxr/trunk/maven-jxr-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr-plugin/src/site/apt/index.apt?rev=901187&r1=901186&r2=901187&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr-plugin/src/site/apt/index.apt (original)
+++ maven/jxr/trunk/maven-jxr-plugin/src/site/apt/index.apt Wed Jan 20 13:26:26 2010
@@ -3,7 +3,7 @@
------
Maria Odea Ching
------
- 4 July 2006
+ 2010-01-20
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -26,13 +26,13 @@
Maven JXR Plugin
- The JXR plugin produces a cross-reference of the project's sources. The generated reports make it easier for the user
- to reference or find specific lines of code. It is also handy when used with the PMD plugin for referencing errors found
+ The JXR Plugin produces a cross-reference of the project's sources. The generated reports make it easier for the user
+ to reference or find specific lines of code. It is also handy when used with the PMD Plugin for referencing errors found
in the code.
* Goals Overview
- The JXR plugin has 2 goals:
+ The JXR Plugin has 2 goals:
* {{{./jxr-mojo.html}jxr:jxr}} is used to generate a cross-reference page of the project's main sources. The generated JXR
files can be linked to the javadocs of the project.
@@ -61,7 +61,7 @@
* Examples
- To provide you with better understanding on some usages of the Javadoc plugin, you can take a look into the
+ To provide you with better understanding on some usages of the JXR Plugin, you can take a look into the
following examples:
* {{{./examples/aggregate.html}Aggregating JXR Reports for Multi-Projects}}
Modified: maven/jxr/trunk/maven-jxr-plugin/src/site/apt/usage.apt.vm
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr-plugin/src/site/apt/usage.apt.vm?rev=901187&r1=901186&r2=901187&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr-plugin/src/site/apt/usage.apt.vm (original)
+++ maven/jxr/trunk/maven-jxr-plugin/src/site/apt/usage.apt.vm Wed Jan 20 13:26:26 2010
@@ -5,7 +5,7 @@
<be...@gmail.com>
Maria Odea Ching
------
- 5 July 2006
+ 2010-01-20
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -28,7 +28,7 @@
Usage
- The JXR plugin generates a cross-reference of the project's sources. Below are the different goals and configuration
+ The JXR Plugin generates a cross-reference of the project's sources. Below are the different goals and configuration
for the plugin.
* Generate JXR as Part of Project Reports
@@ -55,7 +55,7 @@
</project>
+-----+
- The report will be generated when you execute site.
+ The report will be generated when you execute:
+-----+
mvn site
Modified: maven/jxr/trunk/maven-jxr-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/jxr/trunk/maven-jxr-plugin/src/site/site.xml?rev=901187&r1=901186&r2=901187&view=diff
==============================================================================
--- maven/jxr/trunk/maven-jxr-plugin/src/site/site.xml (original)
+++ maven/jxr/trunk/maven-jxr-plugin/src/site/site.xml Wed Jan 20 13:26:26 2010
@@ -20,34 +20,9 @@
-->
<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd"
- name="Maven JXR plugin">
- <bannerLeft>
- <name>${project.name}</name>
- <src>http://maven.apache.org/images/apache-maven-project-2.png</src>
- <href>http://maven.apache.org/plugins/maven-jxr-plugin/</href>
- </bannerLeft>
- <bannerRight>
- <src>http://maven.apache.org/images/maven-logo-2.gif</src>
- </bannerRight>
- <skin>
- <groupId>org.apache.maven.skins</groupId>
- <artifactId>maven-stylus-skin</artifactId>
- </skin>
- <publishDate format="dd MMM yyyy" />
- <version position="left" />
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<body>
- <links>
- <item name="Apache" href="http://www.apache.org/"/>
- <item name="Maven 1.x" href="http://maven.apache.org/maven-1.x"/>
- <item name="Maven 2.x" href="http://maven.apache.org/"/>
- <item name="Maven 2.x Plugins" href="http://maven.apache.org/plugins/"/>
- <item name="SCM" href="http://maven.apache.org/scm"/>
- <item name="Wagon" href="http://maven.apache.org/wagon"/>
- <item name="JXR" href="http://maven.apache.org/jxr"/>
- <item name="Doxia" href="http://maven.apache.org/doxia"/>
- </links>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Goals" href="plugin-info.html"/>
@@ -55,7 +30,7 @@
<item name="FAQ" href="faq.html"/>
</menu>
<menu name="Examples">
- <item name="Aggregating JXR Reports for Multi-Projects" href="/examples/aggregate.html"/>
+ <item name="Aggregating JXR Reports for Multi-module Projects" href="/examples/aggregate.html"/>
<item name="Including/Excluding Source Files" href="/examples/include-exclude.html"/>
<item name="Linking JXR Files to Javadocs" href="/examples/linkjavadoc.html"/>
<item name="JXR Sample Report" href="/xref/index.html"/>