You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2007/10/16 13:24:22 UTC
svn commit: r585121 - in
/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site: apt/index.apt
apt/usage.apt fml/faq.fml site.xml
Author: vsiveton
Date: Tue Oct 16 04:24:20 2007
New Revision: 585121
URL: http://svn.apache.org/viewvc?rev=585121&view=rev
Log:
o updated doc
Modified:
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/apt/index.apt
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/apt/usage.apt
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/fml/faq.fml
maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/site.xml
Modified: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/apt/index.apt?rev=585121&r1=585120&r2=585121&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/apt/index.apt (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/apt/index.apt Tue Oct 16 04:24:20 2007
@@ -3,7 +3,7 @@
------
Vincent Siveton
------
- June 2007
+ October 2007
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -26,19 +26,17 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-Maven Forrestdoc Plugin
+Maven JXR Plugin
- The Forrestdoc Plugin uses the {{{http://svn.apache.org/repos/asf/forrest/trunk/whiteboard/forrestdoc/}Forrestdoc project}}.
- You could see a generated documentation with Forrestdoc
- {{{http://people.apache.org/~nicolaken/whiteboard/forrestdoc/}here}}.
+ The JXR Plugin uses the JXR Java project to generate Java cross reference.
* Goals Overview
- The Forrestdoc Plugin has one goals:
+ The JXR Plugin has one goals:
- * {{{javasrc-mojo.html}forrestdoc:javasrc}} Generates an html-based, cross referenced version of Java
- source code based on the Forrestdoc project..
+ * {{{javasrc-mojo.html}jxr:javasrc}} Generates an html-based, cross referenced version of Java
+ source code based on the JXR Java project..
* Usage
- Instructions on how to use the Forrestdoc Plugin can be found {{{usage.html}here}}.
+ Instructions on how to use the JXR Plugin can be found {{{usage.html}here}}.
Modified: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/apt/usage.apt?rev=585121&r1=585120&r2=585121&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/apt/usage.apt (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/apt/usage.apt Tue Oct 16 04:24:20 2007
@@ -3,7 +3,7 @@
------
Vincent Siveton
------
- June 2007
+ October 2007
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -28,12 +28,12 @@
Usage
- The Forrestdoc Plugin generates an html-based, cross referenced version of Java source code based on
- the {{{http://svn.apache.org/repos/asf/forrest/trunk/whiteboard/forrestdoc/}Forrestdoc project}}. The following examples describe the basic usage of the Plugin.
+ The Maven JXR Plugin generates an html-based, cross referenced version of Java source code.
+ The following examples describe the basic usage of the Plugin.
* Generate Java source code report
- To include Forrestdoc reports in your documentation, you must configure the following in the \<reporting\>
+ To include JXR reports in your documentation, you must configure the following in the \<reporting\>
section of your pom:
+-----+
@@ -43,9 +43,9 @@
<plugins>
...
<plugin>
- <groupId>org.apache.forrest.whiteboard.forrestdoc</groupId>
- <artifactId>maven-forrestdoc-plugin</artifactId>
- <version>1.0-SNAPSHOT</version>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jxr-plugin</artifactId>
+ <version>3.0-SNAPSHOT</version>
</plugin>
...
</plugins>
Modified: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/fml/faq.fml?rev=585121&r1=585120&r2=585121&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/fml/faq.fml (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/fml/faq.fml Tue Oct 16 04:24:20 2007
@@ -21,27 +21,13 @@
<faqs id="FAQ" title="Frequently Asked Questions">
<part id="General">
- <faq id="Why using Apache Forrestdoc">
- <question>Why using Apache Forrestdoc?</question>
- <answer>
- <p>
- Actually, Maven JXR has some limitations descibed in
- <a href="http://jira.codehaus.org/browse/JXR-10">JXR-10</a> and
- <a href="http://jira.codehaus.org/browse/JXR-13">JXR-13</a>.
- </p>
- <p>
- The Apache JXR and Forrestdoc are both using Apache Alexandria, an Apache defunct project.
- The twice team will works together in the future.
- </p>
- </answer>
- </faq>
<faq id="What are the known limitations">
<question>What are the known limitations?</question>
<answer>
<p>
<ul>
- <li>Forrestdoc doesn't handle a custom footer</li>
- <li>Maven Forrestdoc plugin doesn't handle aggregate feature like Maven JXR does</li>
+ <li>JXR Java doesn't handle a custom footer (<a href="http://jira.codehaus.org/browse/MSANDBOX-35">MSANDBOX-35</a>)</li>
+ <li>Maven JXR plugin doesn't handle aggregate feature like Maven JXR does</li>
</ul>
</p>
</answer>
Modified: maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/site.xml?rev=585121&r1=585120&r2=585121&view=diff
==============================================================================
--- maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/site.xml (original)
+++ maven/sandbox/trunk/jxr/maven-jxr/maven-jxr-plugin/src/site/site.xml Tue Oct 16 04:24:20 2007
@@ -20,16 +20,57 @@
-->
<project>
+ <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" />
+
<body>
<links>
- <item name="Forrest" href="http://forrest.apache.org/"/>
+ <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="Continuum" href="http://maven.apache.org/continuum"/>
+ <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>
+ <head>
+ <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
+ </script>
+ <script type="text/javascript">
+ _uacct = "UA-140879-1";
+ urchinTracker();
+ </script>
+ </head>
+
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Goals" href="plugin-info.html"/>
<item name="Usage" href="usage.html"/>
<item name="FAQ" href="faq.html"/>
</menu>
+
+<!--
+ <menu name="Examples"/>
+-->
+
+ <menu ref="reports"/>
</body>
</project>