Return-Path: Mailing-List: contact ant-dev-help@jakarta.apache.org; run by ezmlm Delivered-To: mailing list ant-dev@jakarta.apache.org Received: (qmail 11780 invoked by uid 500); 16 Oct 2000 11:59:35 -0000 Delivered-To: apmail-jakarta-ant-cvs@apache.org Received: (qmail 11765 invoked by uid 1142); 16 Oct 2000 11:59:34 -0000 Date: 16 Oct 2000 11:59:34 -0000 Message-ID: <20001016115934.11754.qmail@locus.apache.org> From: conor@locus.apache.org To: jakarta-ant-cvs@apache.org Subject: cvs commit: jakarta-ant/docs index.html conor 00/10/16 04:59:33 Modified: docs index.html Log: Document the nested element for Javadoc Revision Changes Path 1.132 +22 -0 jakarta-ant/docs/index.html Index: index.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/index.html,v retrieving revision 1.131 retrieving revision 1.132 diff -u -r1.131 -r1.132 --- index.html 2000/10/16 07:34:48 1.131 +++ index.html 2000/10/16 11:59:32 1.132 @@ -3133,6 +3133,28 @@ +

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