From 533852ac99a7391868fbdb4c1d495a019bfddbea Mon Sep 17 00:00:00 2001 From: Conor MacNeill Date: Mon, 16 Oct 2000 11:59:32 +0000 Subject: [PATCH] Document the nested element for Javadoc git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@268094 13f79535-47bb-0310-9956-ffa450edef68 --- docs/index.html | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) 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.

+

doclet

+

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 +<doclet> nested element. Such attributes should only be specified, +therefore, if they can be interpreted by the doclet in use. + +

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

  <javadoc ...>
+     <doclet name="theDoclet"
+             path="path/to/theDoclet">
+        <param name="-foo" value="foovalue"/>
+        <param name="-bar" value="barvalue"/>
+     </doclet>
+  </javadoc>
+
+

sourcepath, classpath and bootclasspath

Javadoc's sourcepath, classpath and bootclasspath attributes are PATH like