diff options
| author | Conor MacNeill <conor@apache.org> | 2000-10-16 11:59:32 +0000 |
|---|---|---|
| committer | Conor MacNeill <conor@apache.org> | 2000-10-16 11:59:32 +0000 |
| commit | 533852ac99a7391868fbdb4c1d495a019bfddbea (patch) | |
| tree | e6de7fcbce9198c81efbed3491d4dbcc66eef025 | |
| parent | cf01e99f9e236a5e394c1a8106e35668b98f579b (diff) | |
| download | ant-533852ac99a7391868fbdb4c1d495a019bfddbea.tar.gz | |
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
| -rw-r--r-- | docs/index.html | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/index.html b/docs/index.html index 32d1e8271..246999674 100644 --- a/docs/index.html +++ b/docs/index.html @@ -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><doclet></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><param></code> elements within the <code><doclet></code> +element. These paramaters are restricted to simple strings. An example usage +of the doclet element is shown below: + +<pre> <javadoc ...> + <doclet name="theDoclet" + path="path/to/theDoclet"> + <param name="-foo" value="foovalue"/> + <param name="-bar" value="barvalue"/> + </doclet> + </javadoc> +</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 |