From d2b1f4eb3ff7bf4f48206d2829b258bbcdc79193 Mon Sep 17 00:00:00 2001 From: Jon Skeet Date: Tue, 26 Feb 2002 10:39:10 +0000 Subject: [PATCH] Added tag option documentation. git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@271559 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/CoreTasks/javadoc.html | 44 ++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/docs/manual/CoreTasks/javadoc.html b/docs/manual/CoreTasks/javadoc.html index 25c93db3d..af91a8430 100644 --- a/docs/manual/CoreTasks/javadoc.html +++ b/docs/manual/CoreTasks/javadoc.html @@ -346,6 +346,13 @@ instead.

1.2 No + + tag + Specifies how custom tags should be handled. See + below for details. + 1.4 + No + additionalparam Lets you add additional parameters to the javadoc @@ -543,6 +550,42 @@ of the doclet element is shown below:

</javadoc> +

tag

+

The tag nested element is used to specify custom tags. This option is only available +with Java 1.4.

+ +
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameName of the tag (e.g. todo)Yes
descriptionDescription for tag (e.g. To do:)Yes
enabledWhether or not the tag is enabled (defaults to true)No
scopeScope for the tag - the elements in which it can be used. This + is a comma separated list of some of the elements: overview, + packages, types, constructors, + methods, fields or the default, all.No
+

sourcepath, classpath and bootclasspath

Javadoc's sourcepath, classpath and bootclasspath attributes are PATH like @@ -562,6 +605,7 @@ respectively.

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://java.sun.com/products/jdk/1.2/docs/api/" packagelistLoc="C:\tmp"/>