You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by gi...@apache.org on 2018/02/28 07:01:48 UTC
[33/47] ant git commit: Use HTML 5(-ish), fix links
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/javadoc.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/javadoc.html b/manual/Tasks/javadoc.html
index 49b17c4..72a4145 100644
--- a/manual/Tasks/javadoc.html
+++ b/manual/Tasks/javadoc.html
@@ -24,613 +24,570 @@
<body>
-<h2 id="javadoc">Javadoc/<i>Javadoc2</i></h2>
+<h2 id="javadoc">Javadoc/<em>Javadoc2</em></h2>
+<p><em><u>Deprecation</u>: the <code>javadoc2</code> task simply points to the <code>javadoc</code>
+task and it's there for backwards compatibility reasons. Since this task will be removed in future
+versions, you are strongly encouraged to use <a href="javadoc.html">javadoc</a> instead.</em></p>
<h3>Description</h3>
-<p>Generates code documentation using the javadoc tool.</p>
-<p>The source directory will be recursively scanned for Java source files to process
-but only those matching the inclusion rules, and not matching the exclusions rules
-will be passed to the javadoc tool. This
-allows wildcards to be used to choose between package names, reducing verbosity
-and management costs over time. This task, however, has no notion of
-"changed" files, unlike the <a href="javac.html">javac</a> task. This means
-all packages will be processed each time this task is run. In general, however,
-this task is used much less frequently.</p>
-<p><strong>Note</strong>: since javadoc calls System.exit(), javadoc cannot be run inside the
-same VM as Apache Ant without breaking functionality. For this reason, this task
-always forks the VM. This overhead is not significant since javadoc is normally a heavy
-application and will be called infrequently.</p>
-<p><strong>Note</strong>: the packagelist attribute allows you to specify the list of packages to
-document outside of the Ant file. It's a much better practice to include everything
-inside the <code>build.xml</code> file. This option was added in order to make it easier to
-migrate from regular makefiles, where you would use this option of javadoc.
-The packages listed in packagelist are not checked, so the task performs even
-if some packages are missing or broken. Use this option if you wish to convert from
-an existing makefile. Once things are running you should then switch to the regular
-notation.</p>
-
-<p><i><b>DEPRECATION:</b> the javadoc2 task simply points to the javadoc task and it's
-there for back compatibility reasons. Since this task will be removed in future
-versions, you are strongly encouraged to use <a href="javadoc.html">javadoc</a>
-instead.</i></p>
-
-<p>In the table below, 1.2 means available if your current Java VM is
-a 1.2 VM (but not 1.3 or later), 1.4+ for any VM of at least version 1.4, otherwise
-any VM of at least version 1.2 is acceptable. JDKs <1.4 are no longer supported.
-If you specify the <code>executable</code> attribute it is up to you
-to ensure that this command supports the attributes you wish to use.</p>
-
-<p><strong>Note</strong>:<br>When generating the JavaDocs for classes which contains annotations
-you maybe get a <tt>java.lang.ClassCastException: com.sun.tools.javadoc.ClassDocImpl</tt>.
-This is due <a href="https://bugs.openjdk.java.net/browse/JDK-6442982" target="_blank">bug-6442982</a>. The cause is that JavaDoc cannot find the implementations of used annotations.
-The workaround is providing the jars with these implementations (like JAXBs <tt>@XmlType</tt>, ...)
-to <javadoc> using <tt>classpath</tt>, <tt>classpathref</tt> attributes or nested
-<classpath> element.</p>
-
-<p><strong>Note</strong>: many problems with running javadoc stem from command
- lines that have become too long - even though the error message
- doesn't give the slightest hint this may be the problem. If you
- encounter problems with the task, try to set
- the <code>useexternalfile</code> attribute to <code>true</code>
- first.</p>
-
-<p>If you use multiple ways to specify where javadoc should be looking
- for sources your result will be the union of all specified
- documentations. If you, e.g., specify a sourcepath attribute and
- also a nested packageset both pointing at the same directory your
- excludepackagenames attribute won't have any effect unless it agrees
- with the exclude patterns of the packageset (and vice versa).</p>
+<p>Generates code documentation using the <code>javadoc</code> tool.</p>
+<p>The source directory will be recursively scanned for Java source files to process but only those
+matching the inclusion rules, and not matching the exclusions rules will be passed to
+the <code>javadoc</code> tool. This allows wildcards to be used to choose between package names,
+reducing verbosity and management costs over time. This task, however, has no notion of
+"changed" files, unlike the <a href="javac.html">javac</a> task. This means all packages
+will be processed each time this task is run. In general, however, this task is used much less
+frequently.</p>
+<p><strong>Note</strong>: since <code>javadoc</code>
+calls <code>System.exit()</code>, <code>javadoc</code> cannot be run inside the same JVM as Apache
+Ant without breaking functionality. For this reason, this task always forks JVM. This overhead is
+not significant since <code>javadoc</code> is normally a heavy application and will be called
+infrequently.</p>
+<p><strong>Note</strong>: the <var>packagelist</var> attribute allows you to specify the list of
+packages to document outside of the Ant file. It's a much better practice to include everything
+inside the <code>build.xml</code> file. This option was added in order to make it easier to migrate
+from regular makefiles, where you would use this option of <code>javadoc</code>. The packages
+listed in <var>packagelist</var> are not checked, so the task performs even if some packages are
+missing or broken. Use this option if you wish to convert from an existing makefile. Once things are
+running you should then switch to the regular notation.</p>
+
+<p>In the table below, 1.2 means available if your current JVM is exactly of version 1.2 (not 1.3 or
+later), 1.4+ for any JVM of at least version 1.4, otherwise any JVM of at least version 1.2 is
+acceptable. JDKs < 1.4 are no longer supported. If you specify the <var>executable</var>
+attribute it is up to you to ensure that this command supports the attributes you wish to use.</p>
+
+<p><strong>Note</strong>: When generating the JavaDocs for classes which contains annotations you
+maybe get a <code>java.lang.ClassCastException: com.sun.tools.javadoc.ClassDocImpl</code>. This is
+due <a href="https://bugs.openjdk.java.net/browse/JDK-6442982" target="_blank">bug-6442982</a>. The
+cause is that JavaDoc cannot find the implementations of used annotations. The workaround is
+providing the jars with these implementations (like JAXBs <code>@XmlType</code>, ...)
+to <code><javadoc></code> using <var>classpath</var>, <var>classpathref</var> attributes or
+nested <code><classpath></code> element.</p>
+
+<p><strong>Note</strong>: many problems with running <code>javadoc</code> stem from command lines
+that have become too long—even though the error message doesn't give the slightest hint this
+may be the problem. If you encounter problems with the task, try to set
+the <var>useexternalfile</var> attribute to <q>true</q> first.</p>
+
+<p>If you use multiple ways to specify where <code>javadoc</code> should be looking for sources,
+your result will be the union of all specified documentations. If you, e.g., specify
+a <var>sourcepath</var> attribute and also a nested <code>packageset</code> both pointing at the
+same directory your <var>excludepackagenames</var> attribute won't have any effect unless it agrees
+with the <var>exclude</var> patterns of the <code>packageset</code> (and vice versa).</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Availability on Java</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Availability on Java</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">sourcepath</td>
- <td valign="top">Specify where to find source files</td>
- <td align="center" valign="top">all</td>
- <td align="center" rowspan="3">At least one of the three or nested
- <code><sourcepath></code>, <code><fileset></code> or
- <code><packageset></code></td>
+ <td>sourcepath</td>
+ <td>Specify where to find source files</td>
+ <td>all</td>
+ <td rowspan="3">At least one of the three or
+ nested <code><sourcepath></code>, <code><fileset></code>
+ or <code><packageset></code></td>
</tr>
<tr>
- <td valign="top">sourcepathref</td>
- <td valign="top">Specify where to find source files by <a
- href="../using.html#references">reference</a> to a PATH defined elsewhere.</td>
- <td align="center" valign="top">all</td>
+ <td>sourcepathref</td>
+ <td>Specify where to find source files by <a href="../using.html#references">reference</a> to a
+ <var>sourcepath</var> defined elsewhere.</td>
+ <td class="left">all</td>
</tr>
<tr>
- <td valign="top">sourcefiles</td>
- <td valign="top">Comma separated list of source files -- see also
- the nested <code>source</code> element.</td>
- <td align="center" valign="top">all</td>
+ <td>sourcefiles</td>
+ <td>Comma separated list of source files—see also the nested <code>source</code>
+ element.</td>
+ <td class="left">all</td>
</tr>
<tr>
- <td valign="top">destdir</td>
- <td valign="top">Destination directory for output files</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">Yes, unless a doclet has been specified.</td>
+ <td>destdir</td>
+ <td>Destination directory for output files</td>
+ <td>all</td>
+ <td>Yes, unless a <var>doclet</var> has been specified.</td>
</tr>
<tr>
- <td valign="top">maxmemory</td>
- <td valign="top">Max amount of memory to allocate to the javadoc VM</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>maxmemory</td>
+ <td>Max amount of memory to allocate to the <code>javadoc</code> JVM</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">packagenames</td>
- <td valign="top">Comma separated list of package files (with terminating
- wildcard) -- see also the nested <code>package</code> element.</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>packagenames</td>
+ <td>Comma separated list of package files (with terminating wildcard)—see also the
+ nested <code>package</code> element.</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">packageList</td>
- <td valign="top">The name of a file containing the packages to process</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>packageList</td>
+ <td>The name of a file containing the packages to process</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">classpath</td>
- <td valign="top">Specify where to find user class files</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>classpath</td>
+ <td>Specify where to find user class files</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Bootclasspath</td>
- <td valign="top">Override location of class files loaded by the bootstrap
- class loader</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Bootclasspath</td>
+ <td>Override location of class files loaded by the bootstrap class loader</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">classpathref</td>
- <td valign="top">Specify where to find user class files by <a
- href="../using.html#references">reference</a> to a PATH defined elsewhere.</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>classpathref</td>
+ <td>Specify where to find user class files by <a href="../using.html#references">reference</a>
+ to a <var>classpath</var> defined elsewhere.</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">bootclasspathref</td>
- <td valign="top">Override location of class files loaded by the
- bootstrap class loader by <a href="../using.html#references">reference</a> to a
- PATH defined elsewhere.</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>bootclasspathref</td>
+ <td>Override location of class files loaded by the bootstrap class loader
+ by <a href="../using.html#references">reference</a> to a <var>bootclasspath</var> defined
+ elsewhere.</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Extdirs</td>
- <td valign="top">Override location of installed extensions</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Extdirs</td>
+ <td>Override location of installed extensions</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Overview</td>
- <td valign="top">Read overview documentation from HTML file</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Overview</td>
+ <td>Read overview documentation from HTML file</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">access</td>
- <td valign="top">Access mode: one of <code>public</code>, <code>protected</code>,
- <code>package</code>, or <code>private</code></td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No (default <code>protected</code>)</td>
+ <td>access</td>
+ <td>Access mode: one of <q>public</q>, <q>protected</q>, <q>package</q>, or <q>private</q></td>
+ <td>all</td>
+ <td>No; default is <q>protected</q></td>
</tr>
<tr>
- <td valign="top">Public</td>
- <td valign="top">Show only public classes and members</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Public</td>
+ <td>Show only public classes and members</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Protected</td>
- <td valign="top">Show protected/public classes and members (default)</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Protected</td>
+ <td>Show protected/public classes and members (default)</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Package</td>
- <td valign="top">Show package/protected/public classes and members</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Package</td>
+ <td>Show package/protected/public classes and members</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Private</td>
- <td valign="top">Show all classes and members</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Private</td>
+ <td>Show all classes and members</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Old</td>
- <td valign="top">Generate output using JDK 1.1 emulating
- doclet.<br>
- <strong>Note</strong>: <em>Since Ant 1.8.0</em> this attribute has no
- effect because javadoc of Java 1.4 and later
- does not support the -1.1 switch anymore.</td>
- <td align="center" valign="top">1.2</td>
- <td align="center" valign="top">No</td>
+ <td>Old</td>
+ <td>Generate output using JDK 1.1 emulating doclet.<br/><strong>Note</strong>: <em>Since Ant
+ 1.8.0</em> this attribute has no effect because <code>javadoc</code> of Java 1.4 and later
+ does not support the <code>-1.1</code> switch anymore.</td>
+ <td>1.2</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Verbose</td>
- <td valign="top">Output messages about what Javadoc is doing</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Verbose</td>
+ <td>Output messages about what Javadoc is doing</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Locale</td>
- <td valign="top">Locale to be used, e.g. en_US or en_US_WIN</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Locale</td>
+ <td>Locale to be used, e.g. <q>en_US</q> or <q>en_US_WIN</q></td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Encoding</td>
- <td valign="top">Source file encoding name</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Encoding</td>
+ <td>Source file encoding name</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Version</td>
- <td valign="top">Include @version paragraphs</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Version</td>
+ <td>Include <code>@version</code> paragraphs</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Use</td>
- <td valign="top">Create class and package usage pages</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Use</td>
+ <td>Create class and package usage pages</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Author</td>
- <td valign="top">Include @author paragraphs</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Author</td>
+ <td>Include <code>@author</code> paragraphs</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Splitindex</td>
- <td valign="top">Split index into one file per letter</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Splitindex</td>
+ <td>Split index into one file per letter</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Windowtitle</td>
- <td valign="top">Browser window title for the documentation (text)</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Windowtitle</td>
+ <td>Browser window title for the documentation (text)</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Doctitle</td>
- <td valign="top">Include title for the package index(first) page (html-code)</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Doctitle</td>
+ <td>Include title for the package index (first) page (HTML code)</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Header</td>
- <td valign="top">Include header text for each page (html-code)</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Header</td>
+ <td>Include header text for each page (HTML code)</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">Footer</td>
- <td valign="top">Include footer text for each page (html-code)</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>Footer</td>
+ <td>Include footer text for each page (HTML code)</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">bottom</td>
- <td valign="top">Include bottom text for each page (html-code)</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>bottom</td>
+ <td>Include bottom text for each page (HTML code)</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">link</td>
- <td valign="top">Create links to javadoc output at the given URL
- -- see also the nested <code>link</code> element.</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>link</td>
+ <td>Create links to <code>javadoc</code> output at the given URL—see also the
+ nested <code>link</code> element.</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">linkoffline</td>
- <td valign="top">Link to docs at <code><url></code> using package list at
- <code><url2></code> - separate the URLs by using a space character -- see
- also the nested <code>link</code> element.</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>linkoffline</td>
+ <td>Link to docs at <samp><em>url</em></samp> using package list
+ at <samp><em>alt-url</em></samp> by specifying a
+ value <q><em>url</em> <em>alt-url</em></q> (space as separator). A shorthand for the
+ nested <code>link</code> element with <var>offline</var>=<q>true</q>.</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">group</td>
- <td valign="top">Group specified packages together in overview
- page. The format is as described <a
- href="#groupattribute">below</a> -- see also the nested
- <code>group</code> element.</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>group</td>
+ <td>Group specified packages together in overview page. The format is as
+ described <a href="#groupattribute">below</a>—see also the nested <code>group</code>
+ element.</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">nodeprecated</td>
- <td valign="top">Do not include @deprecated information</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>nodeprecated</td>
+ <td>Do not include <code>@deprecated</code> information</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">nodeprecatedlist</td>
- <td valign="top">Do not generate deprecated list</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>nodeprecatedlist</td>
+ <td>Do not generate deprecated list</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">notree</td>
- <td valign="top">Do not generate class hierarchy</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>notree</td>
+ <td>Do not generate class hierarchy</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">noindex</td>
- <td valign="top">Do not generate index</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>noindex</td>
+ <td>Do not generate index</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">nohelp</td>
- <td valign="top">Do not generate help link</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>nohelp</td>
+ <td>Do not generate help link</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">nonavbar</td>
- <td valign="top">Do not generate navigation bar</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>nonavbar</td>
+ <td>Do not generate navigation bar</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">serialwarn</td>
- <td valign="top">Generate warning about @serial tag</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>serialwarn</td>
+ <td>Generate warning about <code>@serial</code> tag</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">helpfile</td>
- <td valign="top">Specifies the HTML help file to use</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>helpfile</td>
+ <td>Specifies the HTML help file to use</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">stylesheetfile</td>
- <td valign="top">Specifies the CSS stylesheet to use</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>stylesheetfile</td>
+ <td>Specifies the CSS stylesheet to use</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">charset</td>
- <td valign="top">Charset for cross-platform viewing of generated
- documentation</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>charset</td>
+ <td>Charset for cross-platform viewing of generated documentation</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">docencoding</td>
- <td valign="top">Output file encoding name</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>docencoding</td>
+ <td>Output file encoding name</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">doclet</td>
- <td valign="top">Specifies the class file that starts the doclet
- used in generating the documentation -- see also the nested
- <code>doclet</code> element.</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>doclet</td>
+ <td>Specifies the class file that starts the doclet used in generating the
+ documentation—see also the nested <code>doclet</code> element.</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">docletpath</td>
- <td valign="top">Specifies the path to the doclet class file that is specified with the -doclet option.</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>docletpath</td>
+ <td>Specifies the path to the doclet class file that is specified with the <code>-doclet</code>
+ option.</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">docletpathref</td>
- <td valign="top">Specifies the path to the doclet class file that
- is specified with the -doclet option by <a
- href="../using.html#references">reference</a> to a PATH defined elsewhere.</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
+ <td>docletpathref</td>
+ <td>Specifies the path to the doclet class file that is specified with the <code>-doclet</code>
+ option by <a href="../using.html#references">reference</a> to a PATH defined elsewhere.</td>
+ <td>all</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">additionalparam</td>
- <td valign="top">Lets you add additional parameters to the javadoc
- command line. Useful for doclets. Parameters containing spaces
- need to be quoted using &quot; -- see also the nested
+ <td>additionalparam</td>
+ <td>Lets you add additional parameters to the <code>javadoc</code> command line. Useful for
+ doclets. Parameters containing spaces need to be quoted using &quot;—see also the
+ nested
<code>arg</code> element.</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">failonerror</td>
- <td valign="top">Stop the buildprocess if the command exits with a
- returncode other than 0.</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">failonwarning</td>
- <td valign="top">Stop the buildprocess if a warning is emitted -
- i.e. if javadoc's output contains the word "warning". <em>since
- Ant 1.9.4</em></td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">excludepackagenames</td>
- <td valign="top">comma separated list of packages you don't want
- docs for -- see also the nested <code>excludepackage</code> element.</td>
- <td align="center" valign="top">all</td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">defaultexcludes</td>
- <td valign="top">indicates whether default excludes should be used
- (<code>yes</code> | <code>no</code>); default excludes are used when omitted.</td>
- <td align="center" valign="top">all</td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">useexternalfile</td>
- <td valign="top">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. Also applies to
- the package names specified via the packagenames attribute or
- nested package elements. <em>Since Ant 1.7.0</em>, also applies
- to all the other command line options.
- (<code>yes</code> | <code>no</code>). Default is no.</td>
- <td align="center" valign="top">all</td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">source</td>
- <td valign="top">Necessary to enable javadoc to handle assertions
- present in J2SE v 1.4 source code. Set this to "1.4" to
- documents code that compiles using <code>"javac -source
- 1.4"</code>.<br>
- A default value for this attribute can be provided using the magic
- <a
- href="../javacprops.html#source"><code>ant.build.javac.source</code></a>
- property.</td>
- <td align="center" valign="top">1.4+</td>
- <td align="center" valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">linksource</td>
- <td valign="top">Generate hyperlinks to source files.
- <em>since Ant 1.6</em>.
- (<code>yes</code> | <code>no</code>). Default is no.</td>
- <td align="center" valign="top">1.4+</td>
- <td align="center" valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">breakiterator</td>
- <td valign="top">Use the new breakiterator algorithm.
- <em>since Ant 1.6</em>.
- (<code>yes</code> | <code>no</code>). Default is no.</td>
- <td align="center" valign="top">1.4+</td>
- <td align="center" valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">noqualifier</td>
- <td valign="top">Enables the <code>-noqualifier</code> argument -
- must be <code>all</code> or a colon separated list of packages.
- <em>since Ant 1.6</em>.</td>
- <td align="center" valign="top">1.4+</td>
- <td align="center" valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">includenosourcepackages</td>
- <td valign="top">If set to true, packages that don't contain Java
- source but a package.html will get documented as well.
- <em>since Ant 1.6.3</em>.</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No (default is <code>false</code>)</td>
- </tr>
- <tr>
- <td valign="top">executable</td>
- <td valign="top">Specify a particular <code>javadoc</code> executable
- to use in place of the default binary (found in the same JDK as Ant is running in).
- <em>since Ant 1.6.3</em>.</td>
- <td align="center" valign="top">all</td>
- <td align="center" valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">docfilessubdirs</td>
- <td valign="top">Enables deep-copying of <code>doc-files</code>
- subdirectories. Defaults to false. <em>since Ant 1.8.0</em>.</td>
- <td align="center" valign="top">1.4</td>
- <td align="center" valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">excludedocfilessubdir</td>
- <td valign="top">Colon-separated list of <code>doc-files</code>'
- subdirectories to exclude if <code>docfilessubdirs</code> is
- true. <em>since Ant 1.8.0</em>.</td>
- <td align="center" valign="top">1.4</td>
- <td align="center" valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">postProcessGeneratedJavadocs</td>
- <td valign="top">Whether to post-process the generated javadocs in
- order to mitigate CVE-2013-1571. Defaults to true. <em>Since Ant
- 1.9.2</em><br>
- There is a frame injection attack possible in javadocs generated by Oracle
- JDKs prior to Java 7 update 25 (<a href="http://www.oracle.com/technetwork/java/javase/7u25-relnotes-1955741.html#jpi-upt" target="_blank">details</a>).
- When this flag is set to true, Ant will check whether the docs are vulnerable
- and will try to fix them.
- </td>
- <td align="center" valign="top">1.4</td>
- <td align="center" valign="top">No</td>
+ <td>all</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>failonerror</td>
+ <td>Stop the build process if the command exits with a return code other than 0.</td>
+ <td>all</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>failonwarning</td>
+ <td>Stop the build process if a warning is emitted—i.e. if <code>javadoc</code>'s output
+ contains the word <q>warning</q>. <em>since Ant 1.9.4</em></td>
+ <td>all</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>excludepackagenames</td>
+ <td>comma separated list of packages you don't want docs for—see also the
+ nested <code>excludepackage</code> element.</td>
+ <td>all</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>defaultexcludes</td>
+ <td>indicates whether default excludes should be used (<q>yes|no</q>).</td>
+ <td>all</td>
+ <td>No; defaults to <q>yes</q></td>
+ </tr>
+ <tr>
+ <td>useexternalfile</td>
+ <td>indicates whether the source file names specified in <var>srcfiles</var> or as
+ nested <code>source</code> elements should be written to a temporary file to make the command
+ line shorter. Also applies to the package names specified via the <var>packagenames</var>
+ attribute or nested <code>package</code> elements. <em>Since Ant 1.7.0</em>, also applies to
+ all the other command line options. (<q>yes|no</q>).</td>
+ <td>all</td>
+ <td>No; default is <q>no</q></td>
+ </tr>
+ <tr>
+ <td>source</td>
+ <td>Enable <code>javadoc</code> to handle Java language features. Set this to <q>1.4</q> to
+ document code that compiles using <code>javac -source 1.4</code>, etc.</td>
+ <td>1.4+</td>
+ <td>No; default can be provided using the magic
+ <a href="../javacprops.html#source"><code>ant.build.javac.source</code></a> property.</td>
+ </tr>
+ <tr>
+ <td>linksource</td>
+ <td>Generate hyperlinks to source files. <em>since Ant 1.6</em>. (<q>yes|no</q>).</td>
+ <td>1.4+</td>
+ <td>No; default is <q>no</q></td>
+ </tr>
+ <tr>
+ <td>breakiterator</td>
+ <td>Use the new break iterator algorithm. <em>since Ant 1.6</em>. (<q>yes|no</q>).</td>
+ <td>1.4+</td>
+ <td>No; default is <q>no</q></td>
+ </tr>
+ <tr>
+ <td>noqualifier</td>
+ <td>Enables the <code>-noqualifier</code> argument—must be <q>all</q> or a colon separated
+ list of packages. <em>since Ant 1.6</em>.</td>
+ <td>1.4+</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>includenosourcepackages</td>
+ <td>If set to <q>true</q>, packages that don't contain Java source but
+ a <samp>package.html</samp> will get documented as well. <em>since Ant 1.6.3</em>.</td>
+ <td>all</td>
+ <td>No; default is <q>false</q></td>
+ </tr>
+ <tr>
+ <td>executable</td>
+ <td>Specify a particular <code>javadoc</code> executable to use in place of the default binary
+ (found in the same JDK as Ant is running in). <em>since Ant 1.6.3</em>.</td>
+ <td>all</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>docfilessubdirs</td>
+ <td>Enables deep-copying of <samp>doc-files</samp> subdirectories. <em>since Ant
+ 1.8.0</em>.</td>
+ <td>1.4</td>
+ <td>No; defaults to <q>false</q></td>
+ </tr>
+ <tr>
+ <td>excludedocfilessubdir</td>
+ <td>Colon-separated list of <samp>doc-files</samp> subdirectories to exclude
+ if <var>docfilessubdirs</var> is true. <em>since Ant 1.8.0</em>.</td>
+ <td>1.4</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>postProcessGeneratedJavadocs</td>
+ <td>Whether to post-process the generated javadocs in order to mitigate
+ CVE-2013-1571. <em>Since Ant 1.9.2</em><br> There is a frame injection attack possible in
+ javadocs generated by Oracle JDKs prior to Java 7 update 25
+ (<a href="https://www.oracle.com/technetwork/java/javase/7u25-relnotes-1955741.html#jpi-upt"
+ target="_blank">details</a>). When this flag is set to <q>true</q>, Ant will check whether
+ the docs are vulnerable and will try to fix them.</td>
+ <td>1.4</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
</table>
<h4 id="groupattribute">Format of the group attribute</h4>
-<p>The arguments are comma-delimited. Each single argument is 2
-space-delimited strings, where the first one is the group's title and
-the second one a colon delimited list of packages.</p>
-<p>If you need to specify more than one group, or a group whose title
-contains a comma or a space character, using <a
-href="#groupelement">nested group elements</a> is highly
+<p>The arguments are comma-delimited. Each single argument is 2 space-delimited strings, where the
+first one is the group's title and the second one a colon delimited list of packages.</p>
+<p>If you need to specify more than one group, or a group whose title contains a comma or a space
+character, using <a href="#groupelement">nested <code>group</code> elements</a> is highly
recommended.</p>
<p>E.g.:</p>
-<pre> group="XSLT_Packages org.apache.xalan.xslt*,XPath_Packages org.apache.xalan.xpath*"</pre>
+<pre>group="XSLT_Packages org.apache.xalan.xslt*,XPath_Packages org.apache.xalan.xpath*"</pre>
<h3>Parameters specified as nested elements</h3>
<h4>packageset</h4>
-<p>A <a href="../Types/dirset.html">DirSet</a>. All matched
-directories that contain Java source files will be passed to javadoc
-as package names. Package names are created from the directory names
-by translating the directory separator into dots. Ant assumes the
-base directory of the packageset points to the root of a package
-hierarchy.</p>
+<p>A <a href="../Types/dirset.html">DirSet</a>. All matched directories that contain Java source
+files will be passed to <code>javadoc</code> as package names. Package names are created from the
+directory names by translating the directory separator into dots. Ant assumes the base directory of
+the <code>packageset</code> points to the root of a package hierarchy.</p>
-<p>The <code>packagenames</code>, <code>excludepackagenames</code> and
-<code>defaultexcludes</code> attributes of the task have no effect on
-the nested <code><packageset></code> elements.</p>
+<p>The <var>packagenames</var>, <var>excludepackagenames</var> and <var>defaultexcludes</var>
+attributes of the task have no effect on the nested <code><packageset></code> elements.</p>
<h4>fileset</h4>
-<p>A <a href="../Types/fileset.html">FileSet</a>. All matched
-files will be passed to javadoc as source files. Ant will
-automatically add the include pattern <code>**/*.java</code> (and
-<code>**/package.html</code> if includenosourcepackages is true) to
-these filesets.</p>
+<p>A <a href="../Types/fileset.html">FileSet</a>. All matched files will be passed
+to <code>javadoc</code> as source files. Ant will automatically add the include
+pattern <samp>**/*.java</samp> (and <samp>**/package.html</samp>
+if <var>includenosourcepackages</var> is <q>true</q>) to these filesets.</p>
-<p>Nested filesets can be used to document sources that are in the
-default package or if you want to exclude certain files from
-documentation. If you want to document all source files and don't use
-the default package, packagesets should be used instead as this
-increases javadocs performance.</p>
+<p>Nested filesets can be used to document sources that are in the default package or if you want to
+exclude certain files from documentation. If you want to document all source files and don't use
+the default package, <code>packageset</code>s should be used instead as this increases performance
+of <code>javadoc</code>.</p>
-<p>The <code>packagenames</code>, <code>excludepackagenames</code> and
-<code>defaultexcludes</code> attributes of the task have no effect on
-the nested <code><fileset></code> elements.</p>
+<p>The <var>packagenames</var>, <var>excludepackagenames</var> and <var>defaultexcludes</var>
+attributes of the task have no effect on the nested <code><fileset></code> elements.</p>
<h4>sourcefiles</h4>
-<p>A container for arbitrary file system based <a
-href="../Types/resources.html#collection">resource
-collections</a>. All files contained in any of the nested collections
-(this includes nested filesets, filelists or paths) will be passed to
-javadoc as source files.</p>
+<p>A container for arbitrary file system based <a href="../Types/resources.html#collection">resource
+collections</a>. All files contained in any of the nested collections (this includes nested
+filesets, filelists or paths) will be passed to javadoc as source files.</p>
<h4>package</h4>
-<p>Same as one entry in the list given by <code>packagenames</code>.</p>
+<p>Same as one entry in the list given by <var>packagenames</var>.</p>
<h5>Parameters</h5>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">name</td>
- <td valign="top">The package name (may be a wildcard)</td>
- <td align="center" valign="top">Yes</td>
+ <td>name</td>
+ <td>The package name (may be a wildcard)</td>
+ <td>Yes</td>
</tr>
</table>
<h4>excludepackage</h4>
-<p>Same as one entry in the list given by <code>excludepackagenames</code>.</p>
+<p>Same as one entry in the list given by <var>excludepackagenames</var>.</p>
<h5>Parameters</h5>
Same as for <code>package</code>.
<h4>source</h4>
-<p>Same as one entry in the list given by <code>sourcefiles</code>.</p>
+<p>Same as one entry in the list given by <var>sourcefiles</var>.</p>
<h5>Parameters</h5>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">The source file to document</td>
- <td align="center" valign="top">Yes</td>
+ <td>file</td>
+ <td>The source file to document</td>
+ <td>Yes</td>
</tr>
</table>
<h4>doctitle</h4>
-<p>Same as the <code>doctitle</code> attribute, but you can nest text
-inside the element this way.</p>
+<p>Same as the <var>doctitle</var> attribute, but you can nest text inside the element this way.</p>
-<p>If the nested text contains line breaks, you must use the
- useexternalfile attribute and set it to true.</p>
+<p>If the nested text contains line breaks, you must use the <var>useexternalfile</var> attribute
+and set it to <q>true</q>.</p>
<h4>header</h4>
@@ -645,268 +602,262 @@ inside the element this way.</p>
<p>Similar to <code><doctitle></code>.</p>
<h4>link</h4>
-<p>Create link to javadoc output at the given URL. This performs the
-same role as the link and linkoffline attributes. You can use either
-syntax (or both at once), but with the nested elements you can easily
-specify multiple occurrences of the arguments.</p>
+<p>Create link to <code>javadoc</code> output at the given URL. This performs the same role as
+the <var>link</var> and <var>linkoffline</var> attributes. You can use either syntax (or both at
+once), but with the nested elements you can easily specify multiple occurrences of the
+arguments.</p>
<h5>Parameters</h5>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">href</td>
- <td valign="top">The URL for the external documentation you wish
- to link to. This can be an absolute URL, or a relative file
- name.</td>
- <td align="center" valign="top">Yes</td>
+ <td>href</td>
+ <td>The URL for the external documentation you wish to link to. This can be an absolute URL, or
+ a relative file name.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">offline</td>
- <td valign="top">True if this link is not available online at the time of
- generating the documentation</td>
- <td align="center" valign="top">No</td>
+ <td>offline</td>
+ <td><q>true</q> if this link is not available online at the time of generating the
+ documentation</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">packagelistLoc</td>
- <td valign="top">The location to the directory containing the package-list file for
- the external documentation</td>
- <td align="center" valign="top" rowspan="2">One of the two if the offline attribute is true</td>
+ <td>packagelistLoc</td>
+ <td>The location to the directory containing the package-list file for the external
+ documentation</td>
+ <td rowspan="2">One of the two if the <var>offline</var> attribute is <q>true</q></td>
</tr>
<tr>
- <td valign="top">packagelistURL</td>
- <td valign="top">The URL of the the directory containing the package-list file for
- the external documentation</td>
+ <td>packagelistURL</td>
+ <td class="left">The URL of the the directory containing the package-list file for the external
+ documentation</td>
</tr>
<tr>
- <td valign="top">resolveLink</td>
- <td valign="top">If the link attribute is a relative file name,
- Ant will first try to locate the file relative to the current
- project's basedir and if it finds a file there use an absolute URL
- for the link attribute, otherwise it will pass the file name
- verbatim to the javadoc command.</td>
- <td align="center" valign="top">No, default is false.</td>
+ <td>resolveLink</td>
+ <td>If the <var>link</var> attribute is a relative file name, Ant will first try to locate the
+ file relative to the current project's <var>basedir</var> and if it finds a file there use an
+ absolute URL for the <var>link</var> attribute, otherwise it will pass the file name verbatim
+ to the <code>javadoc</code> command.</td>
+ <td>No; default is <q>false</q></td>
</tr>
</table>
<h4 id="groupelement">group</h4>
-<p>Separates packages on the overview page into whatever groups you
-specify, one group per table. This performs the same role as the group
-attribute. You can use either syntax (or both at once), but with the
-nested elements you can easily specify multiple occurrences of the
+<p>Separates packages on the overview page into whatever groups you specify, one group per
+table. This performs the same role as the <var>group</var> attribute. You can use either syntax (or
+both at once), but with the nested elements you can easily specify multiple occurrences of the
arguments.</p>
<h5>Parameters</h5>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">title</td>
- <td valign="top">Title of the group</td>
- <td align="center" valign="top">Yes, unless nested <code><title></code> given</td>
+ <td>title</td>
+ <td>Title of the group</td>
+ <td>Yes, unless nested <code><title></code> given</td>
</tr>
<tr>
- <td valign="top">packages</td>
- <td valign="top">List of packages to include in that group. Multiple packages are separated with ':'.</td>
- <td align="center" valign="top">Yes, unless nested <code><package></code>s given</td>
+ <td>packages</td>
+ <td>List of packages to include in that group. Multiple packages are separated with <q>:</q>.</td>
+ <td>Yes, unless nested <code><package></code>s given</td>
</tr>
</table>
-<p>The title may be specified as a nested <code><title></code> element
-with text contents, and the packages may be listed with nested
-<code><package></code> elements as for the main task.</p>
+<p>The title may be specified as a nested <code><title></code> element with text contents, and
+the packages may be listed with nested <code><package></code> elements as for the main
+task.</p>
<h4>doclet</h4>
-<p>The doclet nested element is used to specify the
-<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/doclet/overview.html">doclet</a>
-that javadoc will use to process the input source files. A number of the standard javadoc arguments
-are actually arguments of the standard doclet. If these are specified in the javadoc
-task's attributes, they will be passed to the doclet specified in the
-<code><doclet></code> nested element. Such attributes should only be specified,
+<p>The doclet nested element is used to specify
+the <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/doclet/overview.html">doclet</a>
+that <code>javadoc</code> will use to process the input source files. A number of the
+standard <code>javadoc</code> arguments are actually arguments of the standard doclet. If these are
+specified in the <code>javadoc</code> task's attributes, they will be passed to the doclet specified
+in the <code><doclet></code> nested element. Such attributes should only be specified,
therefore, if they can be interpreted by the doclet in use.</p>
-<p>If the doclet requires additional parameters, these can be specified with
-<code><param></code> elements within the <code><doclet></code>
-element. These parameters are restricted to simple strings. An example usage
-of the doclet element is shown below:</p>
+<p>If the doclet requires additional parameters, these can be specified
+with <code><param></code> elements within the <code><doclet></code> element. These
+parameters are restricted to simple strings. An example usage of the <code>doclet</code> element is
+shown below:</p>
-<pre> <javadoc ... >
- <doclet name="theDoclet"
- path="path/to/theDoclet">
- <param name="-foo" value="foovalue"/>
- <param name="-bar" value="barvalue"/>
- </doclet>
- </javadoc>
-</pre>
+<pre>
+<javadoc ... >
+ <doclet name="theDoclet"
+ path="path/to/theDoclet">
+ <param name="-foo" value="foovalue"/>
+ <param name="-bar" value="barvalue"/>
+ </doclet>
+</javadoc></pre>
<h4 id="tagelement">tag</h4>
-<p>If you want to specify a standard tag using a nested tag element
-because you want to determine the order the tags are output, you must
-not set the description attribute for those tags.</p>
+<p>If you want to specify a standard tag using a nested <code>tag</code> element because you want to
+determine the order the tags are output, you must not set the <var>description</var> attribute for
+those tags.</p>
<h5>Parameters</h5>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">name</td>
- <td valign="top">Name of the tag (e.g. <code>todo</code>)</td>
- <td align="center" valign="top">Yes, unless the <code>dir</code> attribute is specified.</td>
+ <td>name</td>
+ <td>Name of the tag (e.g. <q>todo</q>)</td>
+ <td>Yes, unless the <var>dir</var> attribute is specified</td>
</tr>
<tr>
- <td valign="top">description</td>
- <td valign="top">Description for tag (e.g. <code>To do:</code>)</td>
- <td align="center" valign="top">
- No, the javadoc executable will pick a default if this is not specified.
+ <td>description</td>
+ <td>Description for tag (e.g. <q>To do:</q>)</td>
+ <td>
+ No, the <code>javadoc</code> executable will pick a default if this is not specified
</td>
</tr>
<tr>
- <td valign="top">enabled</td>
- <td valign="top">Whether or not the tag is enabled (defaults to <code>true</code>)</td>
- <td align="center" valign="top">No</td>
+ <td>enabled</td>
+ <td>Whether or not the tag is enabled</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
- <td valign="top">scope</td>
- <td valign="top">Scope for the tag - the elements in which it can be used. This
- is a comma separated list of some of the elements: <code>overview</code>,
- <code>packages</code>, <code>types</code>, <code>constructors</code>,
- <code>methods</code>, <code>fields</code> or the default, <code>all</code>.</td>
- <td align="center" valign="top">No</td>
+ <td>scope</td>
+ <td>Scope for the tag—the elements in which it can be used. This is a comma separated list
+ of some of the
+ elements: <q>overview</q>, <q>packages</q>, <q>types</q>, <q>constructors</q>, <q>methods</q>, <q>fields</q>
+ or the default, <q>all</q>.</td>
+ <td>No; defaults to <q>all</q></td>
</tr>
<tr>
- <td valign="top">dir</td>
- <td valign="top">If this attribute is specified, this element will behave as an implicit
- <a href="../Types/fileset.html">fileset</a>. The files included by this fileset should
- contain each tag definition on a separate line, as described in the
- <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#javadoctags">Javadoc reference guide</a>:
- <pre>ejb.bean:t:XDoclet EJB Tag
+ <td>dir</td>
+ <td>If this attribute is specified, this element will behave as an
+ implicit <a href="../Types/fileset.html">fileset</a>. The files included by this fileset
+ should contain each tag definition on a separate line, as described in
+ the <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#javadoctags">Javadoc
+ reference guide</a>:
+ <pre>ejb.bean:t:XDoclet EJB Tag
todo:a:To Do</pre>
- <strong>Note</strong>: The Javadoc reference quide has double quotes around
-the description part of the definition. This will not work when used in
-a file, as the definition is quoted again when given to
-the javadoc program.
- <br/>
+ <strong>Note</strong>: The Javadoc reference quide has double quotes around the description
+ part of the definition. This will not work when used in a file, as the definition is quoted
+ again when given to the <code>javadoc</code> program.<br/>
<strong>Note</strong>: If this attribute is specified, all the other attributes in this
- element will be ignored.
- </td>
- <td align="center" valign="top">No</td>
+ element will be ignored.</td>
+ <td>No</td>
</tr>
</table>
<h4 id="tagletelement">taglet</h4>
-<p>The taglet nested element is used to specify custom
- <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/overview.html">taglets</a> beyond <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#javadoctags" target="_blank">the default taglets</a>.</p>
+<p>The taglet nested element is used to specify
+custom <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/taglet/overview.html">taglets</a>
+beyond <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#javadoctags"
+target="_blank">the default taglets</a>.</p>
<h5>Parameters</h5>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">name</td>
- <td valign="top">The name of the taglet class
- (e.g. <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/ToDoTaglet.java">
- <code>com.sun.tools.doclets.ToDoTaglet</code></a>)</td>
- <td align="center" valign="top">Yes</td>
+ <td>name</td>
+ <td>The name of the taglet class
+ (e.g. <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/taglet/ToDoTaglet.java"><code>com.sun.tools.doclets.ToDoTaglet</code></a>)</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">path</td>
- <td valign="top">A path specifying the search path for the taglet class
- (e.g. <code>/home/taglets</code>).
- The path may also be specified by a nested <code><path></code> element</td>
- <td align="center" valign="top">No</td>
+ <td>path</td>
+ <td>A path specifying the search path for the taglet class (e.g. <samp>/home/taglets</samp>).
+ The path may also be specified by a nested <code><path></code> element</td>
+ <td>No</td>
</tr>
</table>
<h4>sourcepath, classpath and bootclasspath</h4>
-<p><code>Javadoc</code>'s <i>sourcepath</i>, <i>classpath</i> and
-<i>bootclasspath</i> attributes are <a href="../using.html#path">PATH like
-structure</a> and can also be set via nested <i>sourcepath</i>,
-<i>classpath</i> and <i>bootclasspath</i> elements
+<p><code>Javadoc</code>'s <var>sourcepath</var>, <var>classpath</var> and <var>bootclasspath</var>
+attributes are <a href="../using.html#path">path-like structure</a> and can also be set via
+nested <code>sourcepath</code>, <code>classpath</code> and <code>bootclasspath</code> elements
respectively.</p>
<h4>arg</h4>
-<p>Use nested <code><arg></code> to specify additional
-arguments. See <a href="../using.html#arg">Command line
-arguments</a>. <em>Since Ant 1.6</em></p>
+<p>Use nested <code><arg></code> to specify additional arguments.
+See <a href="../using.html#arg">Command line arguments</a>. <em>Since Ant 1.6</em></p>
<h3>Example</h3>
-<pre> <javadoc packagenames="com.dummy.test.*"
- sourcepath="src"
- excludepackagenames="com.dummy.test.doc-files.*"
- defaultexcludes="yes"
- destdir="docs/api"
- author="true"
- version="true"
- use="true"
- windowtitle="Test API">
- <doctitle><![CDATA[<h1>Test</h1>]]></doctitle>
- <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom>
- <tag name="todo" scope="all" description="To do:"/>
- <group title="Group 1 Packages" packages="com.dummy.test.a*"/>
- <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/>
- <link offline="true" href="http://docs.oracle.com/javase/7/docs/api/" packagelistLoc="C:\tmp"/>
- <link href="http://docs.oracle.com/javase/7/docs/api/"/>
- </javadoc></pre>
+<pre>
+<javadoc packagenames="com.dummy.test.*"
+ sourcepath="src"
+ excludepackagenames="com.dummy.test.doc-files.*"
+ defaultexcludes="yes"
+ destdir="docs/api"
+ author="true"
+ version="true"
+ use="true"
+ windowtitle="Test API">
+ <doctitle><![CDATA[<h1>Test</h1>]]></doctitle>
+ <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom>
+ <tag name="todo" scope="all" description="To do:"/>
+ <group title="Group 1 Packages" packages="com.dummy.test.a*"/>
+ <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/>
+ <link offline="true" href="https://docs.oracle.com/javase/8/docs/api/" packagelistLoc="C:\tmp"/>
+ <link href="https://docs.oracle.com/javase/8/docs/api/"/>
+</javadoc></pre>
<p>is the same as</p>
-<pre> <javadoc
- destdir="docs/api"
- author="true"
- version="true"
- use="true"
- windowtitle="Test API">
-
- <packageset dir="src" defaultexcludes="yes">
- <include name="com/dummy/test/**"/>
- <exclude name="com/dummy/test/doc-files/**"/>
- </packageset>
-
- <doctitle><![CDATA[<h1>Test</h1>]]></doctitle>
- <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom>
- <tag name="todo" scope="all" description="To do:"/>
- <group title="Group 1 Packages" packages="com.dummy.test.a*"/>
- <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/>
- <link offline="true" href="http://docs.oracle.com/javase/7/docs/api/" packagelistLoc="C:\tmp"/>
- <link href="http://docs.oracle.com/javase/7/docs/api/"/>
- </javadoc></pre>
+<pre>
+<javadoc destdir="docs/api"
+ author="true"
+ version="true"
+ use="true"
+ windowtitle="Test API">
+
+ <packageset dir="src" defaultexcludes="yes">
+ <include name="com/dummy/test/**"/>
+ <exclude name="com/dummy/test/doc-files/**"/>
+ </packageset>
+
+ <doctitle><![CDATA[<h1>Test</h1>]]></doctitle>
+ <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom>
+ <tag name="todo" scope="all" description="To do:"/>
+ <group title="Group 1 Packages" packages="com.dummy.test.a*"/>
+ <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/>
+ <link offline="true" href="https://docs.oracle.com/javase/8/docs/api/" packagelistLoc="C:\tmp"/>
+ <link href="https://docs.oracle.com/javase/8/docs/api/"/>
+</javadoc></pre>
<p>or</p>
-<pre> <javadoc
- destdir="docs/api"
- author="true"
- version="true"
- use="true"
- windowtitle="Test API">
-
- <fileset dir="src" defaultexcludes="yes">
- <include name="com/dummy/test/**"/>
- <exclude name="com/dummy/test/doc-files/**"/>
- </fileset>
-
- <doctitle><![CDATA[<h1>Test</h1>]]></doctitle>
- <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom>
- <tag name="todo" scope="all" description="To do:"/>
- <group title="Group 1 Packages" packages="com.dummy.test.a*"/>
- <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/>
- <link offline="true" href="http://docs.oracle.com/javase/7/docs/api/" packagelistLoc="C:\tmp"/>
- <link href="http://docs.oracle.com/javase/7/docs/api/"/>
- </javadoc></pre>
+<pre>
+<javadoc destdir="docs/api"
+ author="true"
+ version="true"
+ use="true"
+ windowtitle="Test API">
+
+ <fileset dir="src" defaultexcludes="yes">
+ <include name="com/dummy/test/**"/>
+ <exclude name="com/dummy/test/doc-files/**"/>
+ </fileset>
+
+ <doctitle><![CDATA[<h1>Test</h1>]]></doctitle>
+ <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom>
+ <tag name="todo" scope="all" description="To do:"/>
+ <group title="Group 1 Packages" packages="com.dummy.test.a*"/>
+ <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/>
+ <link offline="true" href="https://docs.oracle.com/javase/8/docs/api/" packagelistLoc="C:\tmp"/>
+ <link href="https://docs.oracle.com/javase/8/docs/api/"/>
+</javadoc></pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/javah.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/javah.html b/manual/Tasks/javah.html
index cbfd67e..e62ad31 100644
--- a/manual/Tasks/javah.html
+++ b/manual/Tasks/javah.html
@@ -27,228 +27,215 @@
<h2 id="javah">Javah</h2>
<h3>Description</h3>
<p>Generates JNI headers from a Java class.</p>
-<p>When this task executes, it will generate the C header and source files that
-are needed to implement native methods. JNI operates differently depending on
-whether <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javah.html">JDK 1.2+</a>
-or <a href="http://java.sun.com/products/jdk/1.1/docs/tooldocs/win32/javah.html">pre-1.2 JDK</a>
-systems are used.</p>
+<p>When this task executes, it will generate the C header and source files that are needed to
+implement native methods. JNI operates differently depending on
+whether <a href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javah.html">JDK
+1.2+</a>
+or <a href="https://web.archive.org/web/20021018232717/http://java.sun.com/products/jdk/1.1/docs/tooldocs/win32/javah.html">pre-1.2
+JDK</a> systems are used.</p>
<p>If you are building with Java 8 or above consider
- using <a href="javac.html"><code>javac</code></a>'s <code>nativeheaderdir</code>
- attribute instead which allows you to compile the classes and
- generate the native header files with a single step.</p>
+using <a href="javac.html"><code>javac</code></a>'s <var>nativeheaderdir</var> attribute instead
+which allows you to compile the classes and generate the native header files in a single step.</p>
-<p><strong>Note</strong>: <code>javah</code> has been deprecated in Java 9
- and removed in Java 10. Attempts to use it with Java 10 will fail.</p>
+<p><strong>Note</strong>: <code>javah</code> has been deprecated in Java 9 and removed in Java
+10. Attempts to use it with Java 10 will fail.</p>
-<p id="implementationvalues">It is possible to use different
-compilers. This can be selected with the <code>implementation</code>
-attribute or a nested element. Here are the choices of the
+<p id="implementationvalues">It is possible to use different compilers. This can be selected with
+the <var>implementation</var> attribute or a nested element. Here are the choices of the
attribute:</p>
<ul>
- <li>default - the default compiler for the platform.</li>
- <li>sun - the standard compiler of the JDK.</li>
- <li>kaffeh - the native standard compiler of <a href="http://www.kaffe.org" target="_top">Kaffe</a>.</li>
- <li>gcjh - the native standard compiler
- of <a href="http://gcc.gnu.org/java/"
- target="_top">gcj and gij</a>. <em>Since Apache Ant 1.8.2</em></li>
- <li>forking - runs the javah executable via its command line
- interface in a separate process. Default when not running on
- Kaffe or gcj/gij <em>since Ant 1.9.8</em></li>
+ <li><q>default</q>—the default compiler for the platform.</li>
+ <li><q>sun</q>—the standard compiler of the JDK.</li>
+ <li><q>kaffeh</q>—the native standard compiler of <a href="http://www.kaffe.org" target="_top">Kaffe</a>.</li>
+ <li><q>gcjh</q>—the native standard compiler
+ of <a href="https://gcc.gnu.org/gcc-7/changes.html#java" target="_top">gcj and
+ gij</a>. <em>Since Apache Ant 1.8.2</em></li>
+ <li><q>forking</q>—runs the <code>javah</code> executable via its command line interface in
+ a separate process. Default when not running on Kaffe or gcj/gij <em>since Ant 1.9.8</em></li>
</ul>
-<p><strong>Note</strong>: if you are using this task to work on multiple files
- the command line may become too long on some operating systems.
- Unfortunately the javah command doesn't support command argument
- files the way javac (for example) does, so all that can be done is
- breaking the amount of classes to compile into smaller chunks.</p>
+<p><strong>Note</strong>: if you are using this task to work on multiple files the command line may
+become too long on some operating systems. Unfortunately the <code>javah</code> command doesn't
+support command argument files the way <code>javac</code> (for example) does, so all that can be
+done is breaking the amount of classes to compile into smaller chunks.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td valign="top" align="center"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">class</td>
- <td valign="top">the fully-qualified name of the class (or classes,
- separated by commas)</td>
- <td align="center" valign="top">Yes</td>
+ <td>class</td>
+ <td>the fully-qualified name of the class (or classes, separated by commas)</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">outputFile</td>
- <td valign="top">concatenates the resulting header or source files for all the classes listed into this file</td>
- <td align="center" valign="middle" rowspan="2">Yes</td>
+ <td>outputFile</td>
+ <td>concatenates the resulting header or source files for all the classes listed into this
+ file</td>
+ <td rowspan="2">Exactly one of the two</td>
</tr>
<tr>
- <td valign="top">destdir</td>
- <td valign="top">sets the directory where javah saves the header files or the
- stub files.</td>
+ <td>destdir</td>
+ <td class="left">sets the directory where <code>javah</code> saves the header files or the stub
+ files.</td>
</tr>
<tr>
- <td valign="top">force</td>
- <td valign="top">specifies that output files should always be written (JDK 1.2 only)</td>
- <td valign="top" align="center">No</td>
+ <td>force</td>
+ <td>specifies that output files should always be written (JDK 1.2 only)</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">old</td>
- <td valign="top">specifies that old JDK 1.0-style header files should be generated
- (otherwise output file contain JNI-style native method function prototypes) (JDK 1.2 only)</td>
- <td valign="top" align="center">No</td>
+ <td>old</td>
+ <td>specifies that old JDK 1.0-style header files should be generated (otherwise output file
+ contain JNI-style native method function prototypes) (JDK 1.2 only)</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">stubs</td>
- <td valign="top">generate C declarations from the Java object file (used with old)</td>
- <td valign="top" align="center">No</td>
+ <td>stubs</td>
+ <td>generate C declarations from the Java object file (used with <var>old</var>)</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">verbose</td>
- <td valign="top">causes Javah to print a message concerning the status of the generated files</td>
- <td valign="top" align="center">No</td>
+ <td>verbose</td>
+ <td>causes <code>Javah</code> to print a message concerning the status of the generated
+ files</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">classpath</td>
- <td valign="top">the classpath to use.</td>
- <td align="center" valign="top">No</td>
+ <td>classpath</td>
+ <td>the classpath to use</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">bootclasspath</td>
- <td valign="top">location of bootstrap class files.</td>
- <td valign="top" align="center">No</td>
+ <td>bootclasspath</td>
+ <td>location of bootstrap class files</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">extdirs</td>
- <td valign="top"> location of installed extensions.</td>
- <td valign="top" align="center">No</td>
+ <td>extdirs</td>
+ <td>location of installed extensions</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">implementation</td>
- <td valign="top">The compiler implementation to use. If this
- attribute is not set, the default compiler for the current VM
- will be used. (See the above <a
- href="#implementationvalues">list</a> of valid compilers.)</td>
- <td align="center" valign="top">No</td>
+ <td>implementation</td>
+ <td>The compiler implementation to use. (See the above <a href="#implementationvalues">list</a>
+ of valid compilers.)</td>
+ <td>No; defaults to default compiler for the current JDK</td>
</tr>
</table>
-<p>Either outputFile or destdir must be supplied, but not both.</p>
<h3>Parameters specified as nested elements</h3>
<h4>arg</h4>
-<p>You can specify additional command line arguments for the compiler
-with nested <code><arg></code> elements. These elements are
-specified like <a href="../using.html#arg">Command-line Arguments</a>
-but have an additional attribute that can be used to enable arguments
-only if a given compiler implementation will be used.</p>
+<p>You can specify additional command line arguments for the compiler with
+nested <code><arg></code> elements. These elements are specified
+like <a href="../using.html#arg">Command-line Arguments</a> but have an additional attribute that
+can be used to enable arguments only if a given compiler implementation will be used.</p>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">value</td>
- <td align="center" rowspan="4">See
- <a href="../using.html#arg">Command-line Arguments</a>.</td>
- <td align="center" rowspan="4">Exactly one of these</td>
+ <td>value</td>
+ <td rowspan="4">See <a href="../using.html#arg">Command-line Arguments</a>.</td>
+ <td rowspan="4">Exactly one of these</td>
</tr>
<tr>
- <td valign="top">line</td>
+ <td class="var">line</td>
</tr>
<tr>
- <td valign="top">file</td>
+ <td class="var">file</td>
</tr>
<tr>
- <td valign="top">path</td>
+ <td class="var">path</td>
</tr>
<tr>
- <td valign="top">prefix</td>
- <td align="center" rowspan="2">See
- <a href="../using.html#arg">Command-line Arguments</a>.
- <em>Since Ant 1.8</em>.</td>
- <td valign="top" align="center">No</td>
+ <td>prefix</td>
+ <td rowspan="2">See <a href="../using.html#arg">Command-line Arguments</a>. <em>Since Ant
+ 1.8</em>.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">suffix</td>
- <td valign="top" align="center">No</td>
+ <td>suffix</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">implementation</td>
- <td>Only pass the specified argument if the chosen compiler
- implementation matches the value of this attribute. Legal values
- are the same as those in the above <a
- href="#implementationvalues">list</a> of valid compilers.)</td>
- <td align="center">No</td>
+ <td>implementation</td>
+ <td>Only pass the specified argument if the chosen compiler implementation matches the value of
+ this attribute. Legal values are the same as those in the
+ above <a href="#implementationvalues">list</a> of valid compilers.)</td>
+ <td>No</td>
</tr>
</table>
<h4>implementationclasspath (<em>since Ant 1.8.0</em>)</h4>
-<p>A <a href="../using.html#path">PATH like structure</a> holding the
- classpath to use when loading the compiler implementation if a
- custom class has been specified. Doesn't have any effect when
- using one of the built-in compilers.</p>
+<p>A <a href="../using.html#path">path-like structure</a> holding the classpath to use when loading
+the compiler implementation if a custom class has been specified. Doesn't have any effect when
+using one of the built-in compilers.</p>
-<h4>Any nested element of a type that implements JavahAdapter
- (<em>since Ant 1.8.0</em>)</h4>
+<h4>Any nested element of a type that implements JavahAdapter (<em>since Ant 1.8.0</em>)</h4>
-<p>If a defined type implements the <code>JavahAdapter</code>
- interface a nested element of that type can be used as an
- alternative to the <code>implementation</code> attribute.</p>
+<p>If a defined type implements the <code>JavahAdapter</code> interface a nested element of that
+type can be used as an alternative to the <var>implementation</var> attribute.</p>
<h3>Examples</h3>
-<pre> <javah destdir="c" class="org.foo.bar.Wibble"/></pre>
-<p>makes a JNI header of the named class, using the JDK 1.2 JNI model. Assuming
-the directory 'c' already exists, the file <tt>org_foo_bar_Wibble.h</tt>
-is created there. If this file already exists, it is left unchanged.</p>
-<pre> <javah outputFile="wibble.h">
- <class name="org.foo.bar.Wibble,org.foo.bar.Bobble"/>
- </javah></pre>
+<pre><javah destdir="c" class="org.foo.bar.Wibble"/></pre>
+<p>makes a JNI header of the named class, using the JDK 1.2 JNI model. Assuming the
+directory <samp>c</samp> already exists, the file <samp>org_foo_bar_Wibble.h</samp> is created
+there. If this file already exists, it is left unchanged.</p>
+<pre>
+<javah outputFile="wibble.h">
+ <class name="org.foo.bar.Wibble,org.foo.bar.Bobble"/>
+</javah></pre>
<p>is similar to the previous example, except the output is written to a file
-called <tt>wibble.h</tt>
-in the current directory.</p>
-<pre> <javah destdir="c" force="yes">
- <class name="org.foo.bar.Wibble"/>
- <class name="org.foo.bar.Bobble"/>
- <class name="org.foo.bar.Tribble"/>
- </javah></pre>
-<p>writes three header files, one for each of the classes named. Because the
-force option is set, these header files are always written when the Javah task
-is invoked, even if they already exist.</p>
-<pre> <javah destdir="c" verbose="yes" old="yes" force="yes">
- <class name="org.foo.bar.Wibble"/>
- <class name="org.foo.bar.Bobble"/>
- <class name="org.foo.bar.Tribble"/>
- </javah>
- <javah destdir="c" verbose="yes" stubs="yes" old="yes" force="yes">
- <class name="org.foo.bar.Wibble"/>
- <class name="org.foo.bar.Bobble"/>
- <class name="org.foo.bar.Tribble"/>
- </javah></pre>
-<p>writes the headers for the three classes using the 'old' JNI format, then
-writes the corresponding .c stubs. The verbose option will cause Javah to
-describe its progress.</p>
-
-<p>If you want to use a custom
- JavahAdapter <code>org.example.MyAdapter</code> you can either
- use the implementation attribute:</p>
+called <samp>wibble.h</samp> in the current directory.</p>
+<pre>
+<javah destdir="c" force="yes">
+ <class name="org.foo.bar.Wibble"/>
+ <class name="org.foo.bar.Bobble"/>
+ <class name="org.foo.bar.Tribble"/>
+</javah></pre>
+<p>writes three header files, one for each of the classes named. Because the force option is set,
+these header files are always written when the <code>Javah</code> task is invoked, even if they
+already exist.</p>
+<pre>
+<javah destdir="c" verbose="yes" old="yes" force="yes">
+ <class name="org.foo.bar.Wibble"/>
+ <class name="org.foo.bar.Bobble"/>
+ <class name="org.foo.bar.Tribble"/>
+</javah>
+<javah destdir="c" verbose="yes" stubs="yes" old="yes" force="yes">
+ <class name="org.foo.bar.Wibble"/>
+ <class name="org.foo.bar.Bobble"/>
+ <class name="org.foo.bar.Tribble"/>
+</javah></pre>
+<p>writes the headers for the three classes using the 'old' JNI format, then writes the
+corresponding <samp>.c</samp> stubs. The verbose option will cause <code>Javah</code> to describe
+its progress.</p>
+
+<p>If you want to use a custom JavahAdapter <code>org.example.MyAdapter</code> you can either use
+the implementation attribute:</p>
<pre>
<javah destdir="c" class="org.foo.bar.Wibble"
- implementation="org.example.MyAdapter"/>
-</pre>
+ implementation="org.example.MyAdapter"/></pre>
<p>or a define a type and nest this into the task like in:</p>
<pre>
<componentdef classname="org.example.MyAdapter"
name="myadapter"/>
<javah destdir="c" class="org.foo.bar.Wibble">
<myadapter/>
-</javah>
-</pre>
-<p>in which case your javah adapter can support attributes and
- nested elements of its own.</p>
+</javah></pre>
+<p>in which case your <code>javah</code> adapter can support attributes and nested elements of its
+own.</p>
</body>
</html>