Browse Source

Document the <doclet> nested element for Javadoc

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@268094 13f79535-47bb-0310-9956-ffa450edef68
master
Conor MacNeill 24 years ago
parent
commit
533852ac99
1 changed files with 22 additions and 0 deletions
  1. +22
    -0
      docs/index.html

+ 22
- 0
docs/index.html View File

@@ -3133,6 +3133,28 @@ arguments.</p>
</tr>
</table>

<h4>doclet</h4>
<p>The doclet nested element is used to specify the doclet 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>&lt;doclet&gt;</code> nested element. Such attributes should only be specified,
therefore, if they can be interpreted by the doclet in use.

<p>If the doclet requires additional parameters, these can be specified with
<code>&lt;param&gt;</code> elements within the <code>&lt;doclet&gt;</code>
element. These paramaters are restricted to simple strings. An example usage
of the doclet element is shown below:

<pre> &lt;javadoc ...&gt;
&lt;doclet name="theDoclet"
path="path/to/theDoclet"&gt;
&lt;param name="-foo" value="foovalue"/&gt;
&lt;param name="-bar" value="barvalue"/&gt;
&lt;/doclet&gt;
&lt;/javadoc&gt;
</pre>

<h4>sourcepath, classpath and bootclasspath</h4>
<p><code>Javadoc</code>'s <em>sourcepath</em>, <em>classpath</em> and
<em>bootclasspath</em> attributes are <a href="#path">PATH like


Loading…
Cancel
Save