From 8bd72d65333484586da86a70f2b57c44baef89ad Mon Sep 17 00:00:00 2001
From: Conor MacNeill <conor@apache.org>
Date: Fri, 5 Apr 2002 05:42:26 +0000
Subject: [PATCH] Add taglets support to javadoc

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@272232 13f79535-47bb-0310-9956-ffa450edef68
---
 docs/manual/CoreTasks/javadoc.html            | 33 +++++++++++----
 .../apache/tools/ant/taskdefs/Javadoc.java    | 42 +++++++++++++++----
 2 files changed, 60 insertions(+), 15 deletions(-)

diff --git a/docs/manual/CoreTasks/javadoc.html b/docs/manual/CoreTasks/javadoc.html
index f0b7992c4..db6f03e92 100644
--- a/docs/manual/CoreTasks/javadoc.html
+++ b/docs/manual/CoreTasks/javadoc.html
@@ -346,13 +346,6 @@ instead.</i></p>
     <td align="center" valign="top">1.2</td>
     <td align="center" valign="top">No</td>
   </tr>
-  <tr>
-    <td valign="top">tag</td>
-    <td valign="top">Specifies how custom tags should be handled. See
-      <a href="#tagelement">below</a> for details.</td>
-    <td align="center" valign="top">1.4</td>
-    <td align="center" valign="top">No</td>
-  </tr>
   <tr>
     <td valign="top">additionalparam</td>
     <td valign="top">Lets you add additional parameters to the javadoc
@@ -586,6 +579,32 @@ with Java 1.4.</p>
   </tr>
 </table>
 
+<h4><a name="tagletelement">taglet</a></h4> 
+<p>The taglet nested element is used to specify custom taglets. This option is 
+only available with Java 1.4.</p>
+
+<h5>Parameters</h5>
+<table width="60%" border="1" cellpadding="2" cellspacing="0">
+  <tr>
+    <td valign="top"><b>Attribute</b></td>
+    <td valign="top"><b>Description</b></td>
+    <td align="center" valign="top"><b>Required</b></td>
+  </tr>
+  <tr>
+    <td valign="top">name</td>
+    <td valign="top">The name of the taglet class 
+              (e.g. <code>com.sun.tools.doclets.ToDoTaglet</code>)</td>
+    <td align="center" valign="top">Yes</td>
+  </tr>
+  <tr>
+    <td valign="top">path</td>
+    <td valign="top">A path specifying the search path for the taglet class
+            (e.g. <code>/home/taglets</code>).
+            The path may also be specified by a nested &lt;path&gt; element</td>
+    <td align="center" valign="top">No</td>
+  </tr>
+</table>
+
 <h4>sourcepath, classpath and bootclasspath</h4>
 <p><code>Javadoc</code>'s <i>sourcepath</i>, <i>classpath</i> and
 <i>bootclasspath</i> attributes are <a href="../using.html#path">PATH like
diff --git a/src/main/org/apache/tools/ant/taskdefs/Javadoc.java b/src/main/org/apache/tools/ant/taskdefs/Javadoc.java
index 4dd23fcd8..44a819f20 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Javadoc.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Javadoc.java
@@ -65,7 +65,7 @@ import java.util.StringTokenizer;
 import org.apache.tools.ant.BuildException;
 import org.apache.tools.ant.DirectoryScanner;
 import org.apache.tools.ant.Project;
-
+import org.apache.tools.ant.ProjectComponent;
 import org.apache.tools.ant.Task;
 import org.apache.tools.ant.types.Path;
 import org.apache.tools.ant.types.Reference;
@@ -128,12 +128,9 @@ public class Javadoc extends Task {
         }
     }
 
-    public class DocletInfo {
+    static public class ExtensionInfo extends ProjectComponent {
         private String name;
         private Path path;
-
-        private Vector params = new Vector();
-
         public void setName(String name) {
             this.name = name;
         }
@@ -167,6 +164,11 @@ public class Javadoc extends Task {
         public void setPathRef(Reference r) {
             createPath().setRefid(r);
         }
+    }
+        
+    public class DocletInfo extends ExtensionInfo {
+
+        private Vector params = new Vector();
 
         public DocletParam createParam() {
             DocletParam param = new DocletParam();
@@ -270,7 +272,8 @@ public class Javadoc extends Task {
     private String packageList = null;
     private Vector links = new Vector(2);
     private Vector groups = new Vector(2);
-    private Vector tags = new Vector(1);
+    private Vector tags = new Vector(5);
+    private Vector taglets = new Vector(2);
     private boolean useDefaultExcludes = true;
     private Html doctitle = null;
     private Html header = null;
@@ -424,6 +427,10 @@ public class Javadoc extends Task {
         return doclet;
     }
 
+    public void addTaglet(ExtensionInfo tagletInfo) {
+        taglets.addElement(tagletInfo);
+    }
+    
     public void setOld(boolean b) {
         add12ArgIf(b, "-1.1");
     }
@@ -971,8 +978,12 @@ public class Javadoc extends Task {
                     toExecute.createArgument().setValue("-doclet");
                     toExecute.createArgument().setValue(doclet.getName());
                     if (doclet.getPath() != null) {
-                        toExecute.createArgument().setValue("-docletpath");
-                        toExecute.createArgument().setPath(doclet.getPath().concatSystemClasspath("ignore"));
+                        Path docletPath 
+                            = doclet.getPath().concatSystemClasspath("ignore");
+                        if (docletPath.size() != 0) {
+                            toExecute.createArgument().setValue("-docletpath");
+                            toExecute.createArgument().setPath(docletPath);
+                        }
                     }
                     for (Enumeration e = doclet.getParams(); e.hasMoreElements();) {
                         DocletParam param = (DocletParam)e.nextElement();
@@ -1068,6 +1079,21 @@ public class Javadoc extends Task {
             
             // JavaDoc 1.4 parameters
             if (javadoc4) {
+                for (Enumeration e = taglets.elements(); e.hasMoreElements(); ) {
+                    ExtensionInfo tagletInfo 
+                        = (ExtensionInfo) e.nextElement();
+                    toExecute.createArgument().setValue("-taglet");
+                    toExecute.createArgument().setValue(tagletInfo.getName());
+                    if (tagletInfo.getPath() != null) {
+                        System.out.println("Taglet base path is " + tagletInfo.getPath());
+                        Path tagletPath 
+                            = tagletInfo.getPath().concatSystemClasspath("ignore");
+                        if (tagletPath.size() != 0) {
+                            toExecute.createArgument().setValue("-tagletpath");
+                            toExecute.createArgument().setPath(tagletPath);
+                        }
+                    }
+                }
                 for (Enumeration e = tags.elements(); e.hasMoreElements(); ) {
                     TagArgument ta = (TagArgument) e.nextElement();
                     toExecute.createArgument().setValue ("-tag");