Author: jjensen
Date: Sat Apr 21 08:45:38 2007
New Revision: 531052
URL: http://svn.apache.org/viewvc?view=rev&rev=531052
Log:
Add Default column and move values there for ease of seeing them.
Modified:
maven/maven-1/plugins/trunk/javadoc/xdocs/properties.xml
Modified: maven/maven-1/plugins/trunk/javadoc/xdocs/properties.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/plugins/trunk/javadoc/xdocs/properties.xml?view=diff&rev=531052&r1=531051&r2=531052
==============================================================================
--- maven/maven-1/plugins/trunk/javadoc/xdocs/properties.xml (original)
+++ maven/maven-1/plugins/trunk/javadoc/xdocs/properties.xml Sat Apr 21
08:45:38 2007
@@ -29,6 +29,7 @@
<th>Property</th>
<th>Optional?</th>
<th>Description</th>
+ <th>Default</th>
</tr>
<tr>
<td>maven.javadoc.additionalparam</td>
@@ -38,6 +39,7 @@
<p>Example (to print what version of javadoc you are using):</p>
<source>maven.javadoc.additionalparam=-J-showversion</source>
</td>
+ <td>(none)</td>
</tr>
<tr>
<td>maven.javadoc.extrasourcepath</td>
@@ -47,14 +49,15 @@
to the <code>sourcepath</code> parameter of the ant javadoc task.
This can be used to add paths for inherited javadocs.
</td>
+ <td>(none)</td>
</tr>
<tr>
<td>maven.javadoc.debug</td>
<td>Yes</td>
<td>
Print informations to debug the plugin.
- The default value is <code>false</code>.
</td>
+ <td>false</td>
</tr>
<tr>
<td>maven.javadoc.excludepackagenames</td>
@@ -62,6 +65,7 @@
<td>
Comma separated list of packages to exclude from the javadoc.
</td>
+ <td>(none)</td>
</tr>
<tr>
<td>maven.javadoc.locale</td>
@@ -72,6 +76,7 @@
Works like the "-locale" option of the javadoc command.
</p>
</td>
+ <td>(none)</td>
</tr>
<tr>
<td>maven.javadoc.maxmemory</td>
@@ -79,8 +84,9 @@
<td>
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. Defaults to <code>512m</code>.
+ the <code>-Xmx</code> parameter.
</td>
+ <td>512m</td>
</tr>
<tr>
<td>maven.javadoc.overview</td>
@@ -90,6 +96,7 @@
Add additional overview documentation to the overview page of the
javadoc.
The documentation must be an HTML file, specified relative to the
project.xml.
</td>
+ <td>(none)</td>
</tr>
<tr>
<td>
@@ -102,8 +109,8 @@
Boolean value.
The scope of classes and members to include in the javadoc.
A <code>true</code> value includes that scope and higher.
- The default value is to include protected scope and higher.
</td>
+ <td>protected scope and higher</td>
</tr>
<tr>
<td>maven.javadoc.source</td>
@@ -113,6 +120,7 @@
<a href="http://ant.apache.org/manual/CoreTasks/javadoc.html";>the
ant javadoc task</a> documentation for more detail.
</td>
+ <td>(none)</td>
</tr>
<tr>
<td>maven.javadoc.useexternalfile</td>
@@ -120,30 +128,34 @@
<td>
indicates whether the sourcefile name specified in srcfiles or as
nested source elements should be written to a temporary file to
make
- the command line shorter. Default value : no.
+ the command line shorter.
</td>
+ <td>no</td>
</tr>
<tr>
<td>maven.javadoc.failonerror</td>
<td>Yes</td>
<td>
Stop the buildprocess if the command exits with a returncode other
- than 0. Default value : false.
+ than 0.
</td>
+ <td>false</td>
</tr>
<tr>
<td>maven.javadoc.javadocreport</td>
<td>Yes</td>
<td>
- Include the javadoc report. Default value: true.
+ Include the javadoc report.
</td>
+ <td>true</td>
</tr>
<tr>
<td>maven.javadoc.warningsreport</td>
<td>Yes</td>
<td>
- Include the javadoc warnings report. Default value: true.
+ Include the javadoc warnings report.
</td>
+ <td>true</td>
</tr>
</table>
</section>
@@ -153,6 +165,7 @@
<th>Property</th>
<th>Optional?</th>
<th>Description</th>
+ <th>Default</th>
</tr>
<tr>
<td>maven.javadoc.author</td>
@@ -161,17 +174,19 @@
Boolean value.
Specifies whether or not the <code>@author</code> text is
included in the generated Javadocs.
- The default value is <code>true</code>.
</td>
+ <td>true</td>
</tr>
<tr>
<td>maven.javadoc.bottom</td>
<td>Yes</td>
<td>
- Specifies the text to be placed at the bottom of each output file.
The default value is
- <source>Copyright ${year} ${pom.organization.name}. All Rights
Reserved.</source>
+ Specifies the text to be placed at the bottom of each output file.
<code>${pom.organization.name}</code>
- expand to value obtained from the project descriptor.
+ expands to value obtained from the project descriptor.
+ </td>
+ <td>
+ Copyright ${year} ${pom.organization.name}. All Rights Reserved.
</td>
</tr>
<tr>
@@ -197,33 +212,37 @@
<strong>Note</strong>: Due to a bug in the jexl expression
evaluator,
custom tag names defined by this property cannot contain dashes.
</td>
+ <td>(none)</td>
</tr>
<tr>
<td>maven.javadoc.destdir</td>
<td>Yes</td>
<td>
The destination directory for all of the generated
- Javadocs. The default value is
- <code>${maven.docs.dest}/apidocs</code>.
+ Javadocs.
</td>
+ <td>${maven.docs.dest}/apidocs</td>
</tr>
<tr>
<td>maven.javadoc.footer</td>
<td>Yes</td>
<td>
Specifies the text or html fragment to be placed to the right of
the bottom navigation bar
- on all pages. The default is to not have a footer. If the footer
is not set,
- but the header is, then Javadoc will user the header in both
places.
+ on all pages.
+ If the footer is not set,
+ but the header is, then Javadoc will use the header in both places.
</td>
+ <td>(none)</td>
</tr>
<tr>
<td>maven.javadoc.header</td>
<td>Yes</td>
<td>
Specifies the text or html fragment to be placed at the top of the
navigation frame in the upper-left corner,
- and to the right of the top navigation bar on all pages. The
default is to not have a header.
+ and to the right of the top navigation bar on all pages.
Javadoc will be use this as the footer as well if the footer is
not set explicitly.
</td>
+ <td>(none)</td>
</tr>
<tr>
<td>maven.javadoc.links</td>
@@ -237,6 +256,7 @@
</p>
<p>See the <a href="faq.html#links">FAQ</a> for more details.</p>
</td>
+ <td>(none)</td>
</tr>
<tr>
<td>
@@ -245,9 +265,6 @@
<td>Yes</td>
<td>
<p>
- Default value is <code>${maven.mode.online}</code>.
- </p>
- <p>
If set, a value of <code>true</code> forces generation of
javadoc in
online mode (using <code>${maven.javadoc.links}</code>).
</p>
@@ -260,6 +277,7 @@
"general" online/offline mode <code>${maven.mode.online}</code>.
</p>
</td>
+ <td>${maven.mode.online}</td>
</tr>
<tr>
<td>maven.javadoc.offlineLinks</td>
@@ -273,14 +291,15 @@
</p>
<p>See the <a href="faq.html#offlineLinks">FAQ</a> for more
details.</p>
</td>
+ <td>(none)</td>
</tr>
<tr>
<td>maven.javadoc.stylesheet</td>
<td>Yes</td>
<td>
Specifies the stylesheet file to use for the javadoc.
- Default is <code>${plugin.resources}/stylesheet.css</code>
</td>
+ <td>${plugin.resources}/stylesheet.css</td>
</tr>
<tr>
<td>
@@ -293,6 +312,7 @@
<a href="http://ant.apache.org/manual/CoreTasks/javadoc.html";>the
ant javadoc task</a> documentation for more detail.
</td>
+ <td>(none)</td>
</tr>
<tr>
<td>maven.javadoc.taglets</td>
@@ -305,6 +325,7 @@
See <a
href="http://ant.apache.org/manual/CoreTasks/javadoc.html";>the
ant javadoc task</a> documentation for more detail.
</td>
+ <td>(none)</td>
</tr>
<tr>
<td>maven.javadoc.use</td>
@@ -312,28 +333,28 @@
<td>
Boolean value.
If <code>true</code>, a "use" page is generated for each class and
member.
- The default value is <code>true</code>.
</td>
+ <td>true</td>
</tr>
<tr>
<td>maven.javadoc.version</td>
<td>Yes</td>
<td>
Specifies whether or not the <code>@version</code> text is
- included in the generated Javadocs. The default value is
- <code>true</code>.
+ included in the generated Javadocs.
</td>
+ <td>true</td>
</tr>
<tr>
<td>maven.javadoc.windowtitle</td>
<td>Yes</td>
<td>
Specifies the window title and the doc title to use for the
generated
- Javadocs. The default value is
- <code>${pom.name} ${pom.currentVersion} API</code>.
+ Javadocs.
<code>${pom.name}</code> and <code>${maven.currentVersion}</code>
expand to values obtained from the project descriptor.
</td>
+ <td>${pom.name} ${pom.currentVersion} API</td>
</tr>
</table>
</section>
