dion 2002/10/01 08:27:17
Modified: src/plugins-build/javadoc/xdocs properties.xml
src/plugins-build/javadoc project.xml plugin.properties
plugin.jelly
Log:
- Added Javadoc maxmemory property as per email from Siegfried Goeschl
<[EMAIL PROTECTED]>
- Documentation was updated and reworked slightly
Revision Changes Path
1.2 +29 -20
jakarta-turbine-maven/src/plugins-build/javadoc/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/plugins-build/javadoc/xdocs/properties.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- properties.xml 15 Aug 2002 05:03:05 -0000 1.1
+++ properties.xml 1 Oct 2002 15:27:17 -0000 1.2
@@ -11,6 +11,15 @@
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
+ <td>maven.javadoc.author</td>
+ <td>Yes</td>
+ <td>
+ Specifies whether or not the <code>@author</code> text is
+ included in the generated Javadocs. The default value is
+ <code>true</code>.
+ </td>
+ </tr>
+ <tr>
<td>maven.javadoc.destdir</td>
<td>Yes</td>
<td>
@@ -20,10 +29,10 @@
</td>
</tr>
<tr>
- <td>maven.javadoc.windowtitle</td>
+ <td>maven.javadoc.doctitle</td>
<td>Yes</td>
<td>
- Specifies the window title to use for the generated
+ Specifies the document title to use for the generated
Javadocs. The default value is <code>${maven.name}
${maven.currentVersion} API</code>. <code>${maven.name}</code>
and <code>${maven.currentVersion}</code> expand to values obtained
@@ -31,32 +40,30 @@
</td>
</tr>
<tr>
- <td>maven.javadoc.doctitle</td>
+ <td>maven.javadoc.private</td>
<td>Yes</td>
<td>
- Specifies the document title to use for the generated
- Javadocs. The default value is <code>${maven.name}
- ${maven.currentVersion} API</code>. <code>${maven.name}</code>
- and <code>${maven.currentVersion}</code> expand to values obtained
- from the project descriptor.
+ Specifies whether or not all classes and members are
+ included in the generated Javadocs. The default value is
+ <code>false</code>.
</td>
</tr>
<tr>
- <td>maven.javadoc.author</td>
+ <td>maven.javadoc.maxmemory</td>
<td>Yes</td>
<td>
- Specifies whether or not the <code>@author</code> text is
- included in the generated Javadocs. The default value is
- <code>true</code>.
+ Specifies the maximum Java heap size to be used when launching
+ the javadoc executable. Some JVMs refer to this property as
+ the <code>-Xmx</code> parameter.
</td>
</tr>
<tr>
- <td>maven.javadoc.private</td>
+ <td>maven.javadoc.use</td>
<td>Yes</td>
<td>
- Specifies whether or not all classes and members are
- included in the generated Javadocs. The default value is
- <code>false</code>.
+ Specifies whether or not a "use" page is generated for
+ each class and member. The default value is
+ <code>true</code>.
</td>
</tr>
<tr>
@@ -69,12 +76,14 @@
</td>
</tr>
<tr>
- <td>maven.javadoc.use</td>
+ <td>maven.javadoc.windowtitle</td>
<td>Yes</td>
<td>
- Specifies whether or not a "use" page is generated for
- each class and member. The default value is
- <code>true</code>.
+ Specifies the window title to use for the generated
+ Javadocs. The default value is <code>${maven.name}
+ ${maven.currentVersion} API</code>. <code>${maven.name}</code>
+ and <code>${maven.currentVersion}</code> expand to values obtained
+ from the project descriptor.
</td>
</tr>
</table>
1.10 +2 -1 jakarta-turbine-maven/src/plugins-build/javadoc/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/javadoc/project.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- project.xml 16 Sep 2002 03:41:42 -0000 1.9
+++ project.xml 1 Oct 2002 15:27:17 -0000 1.10
@@ -4,7 +4,7 @@
<pomVersion>3</pomVersion>
<id>maven-javadoc-plugin</id>
<name>Maven Javadoc Plug-in</name>
- <currentVersion>1.0</currentVersion>
+ <currentVersion>1.1-SNAPSHOT</currentVersion>
<organization>
<name>Apache Software Foundation</name>
<url>http://jakarta.apache.org/</url>
@@ -38,6 +38,7 @@
<organization>Multitask Consulting</organization>
<roles>
<role>Documentation</role>
+ <role>Jelly Developer</role>
</roles>
</developer>
1.4 +5 -4
jakarta-turbine-maven/src/plugins-build/javadoc/plugin.properties
Index: plugin.properties
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/plugins-build/javadoc/plugin.properties,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- plugin.properties 2 Aug 2002 14:47:17 -0000 1.3
+++ plugin.properties 1 Oct 2002 15:27:17 -0000 1.4
@@ -4,10 +4,11 @@
# Javadoc plugin.
# -------------------------------------------------------------------
-maven.javadoc.destdir = ${maven.docs.dest}/apidocs
maven.javadoc.author = true
-maven.javadoc.private = false
-maven.javadoc.version = true
-maven.javadoc.use = true
+maven.javadoc.destdir = ${maven.docs.dest}/apidocs
maven.javadoc.links =
+#maven.javadoc.maxmemory
+maven.javadoc.private = false
maven.javadoc.stylesheet = ${plugin.dir}/stylesheet.css
+maven.javadoc.use = true
+maven.javadoc.version = true
1.5 +7 -0 jakarta-turbine-maven/src/plugins-build/javadoc/plugin.jelly
Index: plugin.jelly
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/plugins-build/javadoc/plugin.jelly,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- plugin.jelly 2 Aug 2002 14:47:17 -0000 1.4
+++ plugin.jelly 1 Oct 2002 15:27:17 -0000 1.5
@@ -46,6 +46,8 @@
<echo>Linking with API information from ${link.trim()} ...</echo>
</j:forEach>
+ <j:set var="maxMemory" value="${maven.javadoc.maxmemory}" />
+
<javadoc
sourcepath="${pom.build.sourceDirectory}"
packagenames="${pom.package}.*"
@@ -65,6 +67,11 @@
<path refid="maven.dependency.classpath"/>
<path location="${maven.build.dest}"/>
</classpath>
+
+ <j:if test="${maxMemory != null}">
+ <setProperty name="maxmemory" value="${maven.javadoc.maxmemory}" />
+ </j:if>
+
</javadoc>
</j:if>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
