From 866680890af58875e0d546e471b3ef63c1fbac6c Mon Sep 17 00:00:00 2001
From: markt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Date: Tue, 3 Aug 2010 12:20:57 +0000
Subject: [PATCH] Provide Javadoc for Servlet, JSP & EL Provide external links
 to JAX-RPC Javadoc

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@981841 13f79535-47bb-0310-9956-ffa450edef68
---
 build.xml                          | 70 +++++++++++++++++++++++++++++++++++---
 webapps/docs/api/index.html        |  5 +--
 webapps/docs/elapi/index.html      | 34 ++++++++++++++++++
 webapps/docs/jspapi/index.html     | 34 ++++++++++++++++++
 webapps/docs/project.xml           |  5 ++-
 webapps/docs/servletapi/index.html | 34 ++++++++++++++++++
 6 files changed, 175 insertions(+), 7 deletions(-)
 create mode 100644 webapps/docs/elapi/index.html
 create mode 100644 webapps/docs/jspapi/index.html
 create mode 100644 webapps/docs/servletapi/index.html

diff --git a/build.xml b/build.xml
index 2d5a6ddf8..680e9b5cd 100644
--- a/build.xml
+++ b/build.xml
@@ -1133,9 +1133,9 @@
 
   </target>
 
-  <target name="extras-webservices"
-          depends="extras-prepare,compile,build-manifests"
-          description="Build web services extras package">
+  <target name="extras-webservices-prepare"
+          depends="extras-prepare"
+          description="Prepare to build web services extras package">
 
     <antcall target="downloadfile">
       <param name="sourcefile" value="${jaxrpc-lib.loc}"/>
@@ -1153,6 +1153,11 @@
           tofile="${tomcat.extras}/webservices/jaxrpc.jar" />
     <copy file="${wsdl4j-lib.jar}"
           tofile="${tomcat.extras}/webservices/wsdl4j.jar" />
+  </target>
+
+  <target name="extras-webservices"
+          depends="extras-webservices-prepare,compile,build-manifests"
+          description="Build web services extras package">
 
     <!-- Compile web services classes components -->
     <javac srcdir="java" destdir="${tomcat.classes}"
@@ -1335,8 +1340,60 @@ Apache Tomcat ${version} native binaries for Win64 AMD64/EMT64 platform.
     
   </target>
 
-  <target name="javadoc" depends="dist-source,extras-prepare"
+  <target name="javadoc" depends="dist-source,extras-webservices-prepare"
     description="Create the Tomcat javadoc" >
+    <javadoc packagenames="javax.servlet.*"
+      excludepackagenames="javax.servlet.jsp.*"
+      sourcepath="${tomcat.dist}/src/java"
+      destdir="${tomcat.dist}/webapps/docs/servletapi"
+      version="true"
+      windowtitle="Servlet 3.0 API Documentation - Apache Tomcat ${version}"
+      doctitle="Servlet 3.0 API - Apache Tomcat ${version}"
+      header="&lt;b&gt;Servlet 3.0 - Apache Tomcat ${version}&lt;/b&gt;"
+      bottom="Copyright &amp;#169; 2000-${year} Apache Software Foundation. All Rights Reserved."
+      encoding="ISO-8859-1"
+      additionalparam="-breakiterator"
+      maxmemory="256m" >
+      <classpath>
+        <path refid="compile.classpath"/>
+        <path refid="tomcat.webservices.classpath"/>
+        <path location="${ant.core.lib}"/>
+      </classpath>
+    </javadoc>
+    <javadoc packagenames="javax.servlet.jsp.*"
+      sourcepath="${tomcat.dist}/src/java"
+      destdir="${tomcat.dist}/webapps/docs/jspapi"
+      version="true"
+      windowtitle="JSP 2.2 API Documentation - Apache Tomcat ${version}"
+      doctitle="JSP 2.2 API - Apache Tomcat ${version}"
+      header="&lt;b&gt;JSP 2.2 - Apache Tomcat ${version}&lt;/b&gt;"
+      bottom="Copyright &amp;#169; 2000-${year} Apache Software Foundation. All Rights Reserved."
+      encoding="ISO-8859-1"
+      additionalparam="-breakiterator"
+      maxmemory="256m" >
+      <classpath>
+        <path refid="compile.classpath"/>
+        <path refid="tomcat.webservices.classpath"/>
+        <path location="${ant.core.lib}"/>
+      </classpath>
+    </javadoc>
+    <javadoc packagenames="javax.el.*"
+      sourcepath="${tomcat.dist}/src/java"
+      destdir="${tomcat.dist}/webapps/docs/elapi"
+      version="true"
+      windowtitle="EL 2.2 API Documentation - Apache Tomcat ${version}"
+      doctitle="EL 2.2 API - Apache Tomcat ${version}"
+      header="&lt;b&gt;EL 2.2 - Apache Tomcat ${version}&lt;/b&gt;"
+      bottom="Copyright &amp;#169; 2000-${year} Apache Software Foundation. All Rights Reserved."
+      encoding="ISO-8859-1"
+      additionalparam="-breakiterator"
+      maxmemory="256m" >
+      <classpath>
+        <path refid="compile.classpath"/>
+        <path refid="tomcat.webservices.classpath"/>
+        <path location="${ant.core.lib}"/>
+      </classpath>
+    </javadoc>
     <javadoc packagenames="org.apache.*"
       sourcepath="${tomcat.dist}/src/java"
       destdir="${tomcat.dist}/webapps/docs/api"
@@ -1353,7 +1410,12 @@ Apache Tomcat ${version} native binaries for Win64 AMD64/EMT64 platform.
         <path refid="tomcat.webservices.classpath"/>
         <path location="${ant.core.lib}"/>
       </classpath>
+      <link href="../servletapi"/>
+      <link href="../jspapi"/>
+      <link href="../elapi"/>
       <link href="http://java.sun.com/j2se/1.6.0/docs/api/"/>
+      <link href="http://commons.apache.org/io/api-release/"/>
+      <link href="http://download-llnw.oracle.com/javaee/6/api/"/>
     </javadoc>
   </target>
 
diff --git a/webapps/docs/api/index.html b/webapps/docs/api/index.html
index bd48398e7..9c125b917 100644
--- a/webapps/docs/api/index.html
+++ b/webapps/docs/api/index.html
@@ -23,11 +23,12 @@
 
 <body>
 
-Tomcat's internal javadoc is no longer installed by default. Download and install 
+Tomcat's internal javadoc is not installed by default. Download and install 
 the "fulldocs" package to get it.
 
 You can also access the javadoc online in the Tomcat 
-<a href="http://tomcat.apache.org/tomcat-7.0-doc/">documentation bundle</a>.
+<a href="http://tomcat.apache.org/tomcat-@VERSION_MAJOR_MINOR@-doc/">
+documentation bundle</a>.
 
 </body>
 </html>
diff --git a/webapps/docs/elapi/index.html b/webapps/docs/elapi/index.html
new file mode 100644
index 000000000..fee5f54e7
--- /dev/null
+++ b/webapps/docs/elapi/index.html
@@ -0,0 +1,34 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!doctype html public "-//w3c//dtd html 4.0 transitional//en" "http://www.w3.org/TR/REC-html40/strict.dtd">
+<html>
+    <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+    <title>API docs</title>
+</head>
+
+<body>
+
+The EL Javadoc is not installed by default. Download and install 
+the "fulldocs" package to get it.
+
+You can also access the javadoc online in the Tomcat 
+<a href="http://tomcat.apache.org/tomcat-@VERSION_MAJOR_MINOR@-doc/">
+documentation bundle</a>.
+
+</body>
+</html>
diff --git a/webapps/docs/jspapi/index.html b/webapps/docs/jspapi/index.html
new file mode 100644
index 000000000..6e8e8414a
--- /dev/null
+++ b/webapps/docs/jspapi/index.html
@@ -0,0 +1,34 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!doctype html public "-//w3c//dtd html 4.0 transitional//en" "http://www.w3.org/TR/REC-html40/strict.dtd">
+<html>
+    <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+    <title>API docs</title>
+</head>
+
+<body>
+
+The JSP Javadoc is not installed by default. Download and install 
+the "fulldocs" package to get it.
+
+You can also access the javadoc online in the Tomcat 
+<a href="http://tomcat.apache.org/tomcat-@VERSION_MAJOR_MINOR@-doc/">
+documentation bundle</a>.
+
+</body>
+</html>
diff --git a/webapps/docs/project.xml b/webapps/docs/project.xml
index 6012a6127..56ea43669 100644
--- a/webapps/docs/project.xml
+++ b/webapps/docs/project.xml
@@ -72,7 +72,10 @@
     <menu name="Reference">
         <item name="Release Notes"         href="RELEASE-NOTES.txt"/>
         <item name="Configuration"         href="config/index.html"/>
-        <item name="Javadocs"              href="api/index.html"/>
+        <item name="Tomcat Javadocs"       href="api/index.html"/>
+        <item name="Servlet Javadocs"      href="servletapi/index.html"/>
+        <item name="JSP 2.2 Javadocs"      href="jspapi/index.html"/>
+        <item name="EL 2.2 Javadocs"       href="elapi/index.html"/>
         <item name="JK 1.2 Documentation"      
               href="http://tomcat.apache.org/connectors-doc/"/>
     </menu>
diff --git a/webapps/docs/servletapi/index.html b/webapps/docs/servletapi/index.html
new file mode 100644
index 000000000..156660c03
--- /dev/null
+++ b/webapps/docs/servletapi/index.html
@@ -0,0 +1,34 @@
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!doctype html public "-//w3c//dtd html 4.0 transitional//en" "http://www.w3.org/TR/REC-html40/strict.dtd">
+<html>
+    <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+    <title>API docs</title>
+</head>
+
+<body>
+
+The Servlet Javadoc is not installed by default. Download and install 
+the "fulldocs" package to get it.
+
+You can also access the javadoc online in the Tomcat 
+<a href="http://tomcat.apache.org/tomcat-@VERSION_MAJOR_MINOR@-doc/">
+documentation bundle</a>.
+
+</body>
+</html>
-- 
2.11.0