Author: oching
Date: Mon Jul 10 02:26:51 2006
New Revision: 420466
URL: http://svn.apache.org/viewvc?rev=420466&view=rev
Log:
Revise plugin documentation.
Modified:
maven/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/aggregate.apt
maven/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/linkjavadoc.apt
maven/plugins/trunk/maven-jxr-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-jxr-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-jxr-plugin/src/site/fml/faq.fml
maven/plugins/trunk/maven-jxr-plugin/src/site/site.xml
Modified:
maven/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/aggregate.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/aggregate.apt?rev=420466&r1=420465&r2=420466&view=diff
==============================================================================
--- maven/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/aggregate.apt
(original)
+++ maven/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/aggregate.apt
Mon Jul 10 02:26:51 2006
@@ -9,7 +9,7 @@
Aggregating JXR Reports for Multi-Projects
- The aggregate parameter of the JXR plugin can be used to generate JXR files
for multi-module projects. Using this parameter,
+ 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
each module.
@@ -72,6 +72,6 @@
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
+ 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/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/linkjavadoc.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/linkjavadoc.apt?rev=420466&r1=420465&r2=420466&view=diff
==============================================================================
--- maven/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/linkjavadoc.apt
(original)
+++ maven/plugins/trunk/maven-jxr-plugin/src/site/apt/examples/linkjavadoc.apt
Mon Jul 10 02:26:51 2006
@@ -16,22 +16,14 @@
...
<reporting>
<plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- ...
- <destDir>C:/Project/target/site/javadocs</destDir>
- ...
- </configuration>
- </plugin>
+ ...
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jxr-plugin</artifactId>
<configuration>
...
<linkJavadoc>true</linkJavadoc>
- <javadocDir>C:/Project/target/site/javadocs</javadocDir>
+ <javadocDir>/path/to/javadocs</javadocDir>
...
</configuration>
</plugin>
@@ -44,5 +36,8 @@
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.
\ No newline at end of file
+ configuration in the reporting section of the pom), the link will no longer
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
Modified: maven/plugins/trunk/maven-jxr-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jxr-plugin/src/site/apt/index.apt?rev=420466&r1=420465&r2=420466&view=diff
==============================================================================
--- maven/plugins/trunk/maven-jxr-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-jxr-plugin/src/site/apt/index.apt Mon Jul 10
02:26:51 2006
@@ -1,5 +1,5 @@
------
- Overview
+ Introduction
------
Maria Odea Ching
------
@@ -7,30 +7,32 @@
------
-
-Overview
+Maven 2 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
in the code.
-
* Goals Overview
The JXR plugin has 2 goals:
- * {{{plugin-info.html}jxr:jxr}} is used to generate a cross-reference page
of the project's main sources. The generated JXR
+ * {{{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.
- * {{{plugin-info.html}jxr:test-jxr}} on the other hand, is used to generate
a cross-reference page of the project's test sources.
+ * {{{test-jxr-mojo.html}jxr:test-jxr}} on the other hand, is used to
generate a cross-reference page of the project's test sources.
* Usage
- Some basic instructions for configuring and using the mojos of the
<<<maven-jxr-plugin>>> can be found in
- the {{{usage.html}Usage guide}}.
+ Instructions on how to use the JXR Plugin can be found {{{usage.html}here}}.
* Examples
- Sample use-cases for the plugin are available under the Examples menu.
+ To provide you with better understanding on some usages of the Javadoc
plugin, you can take a look into the
+ following examples:
+
+ * {{{examples/aggregate.html}Aggregating JXR Reports for Multi-Projects}}
+
+ * {{{examples/linkjavadoc.html}Linking JXR Files to Javadocs}}
Modified: maven/plugins/trunk/maven-jxr-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jxr-plugin/src/site/apt/usage.apt?rev=420466&r1=420465&r2=420466&view=diff
==============================================================================
--- maven/plugins/trunk/maven-jxr-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-jxr-plugin/src/site/apt/usage.apt Mon Jul 10
02:26:51 2006
@@ -1,5 +1,5 @@
------
- How To Use
+ Usage
------
Fabrice Bellingard
<[EMAIL PROTECTED]>
@@ -8,7 +8,7 @@
5 July 2006
------
-How To Use
+Usage
The JXR plugin generates a cross-reference of the project's sources. Below
are the different goals and configuration
for the plugin.
@@ -20,51 +20,29 @@
+-----+
<project>
- ...
+ ...
<build>
- ...
+ ...
</build>
-
<reporting>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-jxr-plugin</artifactId>
- </plugin>
- </plugins>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jxr-plugin</artifactId>
+ </plugin>
+ </plugins>
</reporting>
- ...
+ ...
</project>
+-----+
- The report will be generated when you execute the m2 site plugin.
+ The report will be generated when you execute site.
+-----+
-mvn site:site
+mvn site
+-----+
* Explicitly Generate JXR Files
-
- To explicitly generate JXR files with specific configuration, set the
following in the \<build\> section of your pom.xml:
-
-+-----+
-<project>
- ...
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-jxr-plugin</artifactId>
- <configuration>
- <bottom>Copyright 2006</bottom>
- <docTitle>Maven 2 JXR Plugin Reference</docTitle>
- </configuration>
- </plugin>
- </plugins>
- </build>
- ...
-</project>
-+-----+
The JXR files for the project's main sources will be executed using this
command:
Modified: maven/plugins/trunk/maven-jxr-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jxr-plugin/src/site/fml/faq.fml?rev=420466&r1=420465&r2=420466&view=diff
==============================================================================
--- maven/plugins/trunk/maven-jxr-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-jxr-plugin/src/site/fml/faq.fml Mon Jul 10
02:26:51 2006
@@ -1,9 +1,14 @@
<?xml version="1.0"?>
-<faqs id="General FAQ">
+<faqs id="FAQ" title="Frequently Asked Questions">
<part id="General">
- <faq id="1">
- <question>What is the use of the JXR plugin?</question>
- <answer><p>The JXR plugin is used to generate cross-reference pages of
the source codes of a project. It is generally used when you want to lookup
certain lines of code using line numbers as reference.</p></answer>
+ <faq id="Where do I configure the JXR report">
+ <question>Where do I configure the JXR report?</question>
+ <answer>
+ <p>
+ The JXR report should be configured in the <i>reporting</i> section of
your pom. It would be included in the
+ generated reports when mvn site is executed.
+ </p>
+ </answer>
</faq>
</part>
</faqs>
Modified: maven/plugins/trunk/maven-jxr-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jxr-plugin/src/site/site.xml?rev=420466&r1=420465&r2=420466&view=diff
==============================================================================
--- maven/plugins/trunk/maven-jxr-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-jxr-plugin/src/site/site.xml Mon Jul 10 02:26:51
2006
@@ -12,7 +12,8 @@
<item name="Maven 2" href="http://maven.apache.org"/>
</links>
<menu name="Overview">
- <item name="Overview" href="index.html"/>
+ <item name="Introduction" href="index.html"/>
+ <item name="Goals" href="plugin-info.html"/>
<item name="Usage" href="usage.html"/>
<item name="FAQs" href="faq.html"/>
</menu>
@@ -20,7 +21,7 @@
<menu name="Examples">
<item name="Aggregating JXR Reports for Multi-Projects"
href="/examples/aggregate.html"/>
<item name="Linking JXR Files to Javadocs"
href="/examples/linkjavadoc.html"/>
- <item name="JXR Sample Report" href="/example/xref/index.html"/>
+ <item name="JXR Sample Report" href="/xref/index.html"/>
</menu>
${reports}
</body>
