[tomcat] 02/02: Add Javadoc for the Common Annotation API

[markt]

This is an automated email from the ASF dual-hosted git repository.

markt pushed a commit to branch 8.5.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git

commit 99e5ea8e5008e8f14c8c2c224d2f98386cc3e4ba
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Mon Sep 23 21:32:55 2019 +0100

    Add Javadoc for the Common Annotation API
---
 build.xml                           | 22 ++++++++++++++++++++++
 java/javax/annotation/Resource.java |  4 ++++
 webapps/docs/changelog.xml          |  7 +++++++
 webapps/docs/project.xml            |  4 +++-
 4 files changed, 36 insertions(+), 1 deletion(-)

diff --git a/build.xml b/build.xml
index 569afa5..63d7989 100644
--- a/build.xml
+++ b/build.xml
@@ -1847,6 +1847,27 @@ Apache Tomcat ${version} native binaries for Win64 
AMD64/EMT64 platform.
 
   <target name="javadoc" depends="dist-source,extras-webservices-prepare"
     description="Create the Tomcat javadoc" >
+    <javadoc packagenames="javax.annotation.*"
+      sourcepath="${tomcat.dist}/src/java"
+      destdir="${tomcat.dist}/webapps/docs/annotationapi"
+      version="true"
+      windowtitle="Common Annotations 1.2 API Documentation - Apache Tomcat 
${version}"
+      doctitle="Common Annotations 1.2 API - Apache Tomcat ${version}"
+      header="&lt;b&gt;Common Annotations 1.2 - Apache Tomcat 
${version}&lt;/b&gt;"
+      bottom="Copyright &amp;#169; 2000-${year} Apache Software Foundation. 
All Rights Reserved."
+      encoding="UTF-8"
+      docencoding="UTF-8"
+      charset="UTF-8"
+      additionalparam="-breakiterator -notimestamp ${java9.javadoc.options}"
+      source="${compile.source}"
+      maxmemory="512m"
+      failonerror="true"
+      failonwarning="true">
+      <classpath>
+        <path refid="compile.classpath"/>
+        <path location="${ant.core.lib}"/>
+      </classpath>
+    </javadoc>
     <javadoc packagenames="javax.servlet.*"
       excludepackagenames="javax.servlet.jsp.*"
       sourcepath="${tomcat.dist}/src/java"
@@ -1976,6 +1997,7 @@ Apache Tomcat ${version} native binaries for Win64 
AMD64/EMT64 platform.
         <path refid="tomcat.webservices.classpath"/>
         <path location="${ant.core.lib}"/>
       </classpath>
+      <link href="../annotationapi"/>
       <link href="../servletapi"/>
       <link href="../jspapi"/>
       <link href="../elapi"/>
diff --git a/java/javax/annotation/Resource.java 
b/java/javax/annotation/Resource.java
index af3736c..498ca22 100644
--- a/java/javax/annotation/Resource.java
+++ b/java/javax/annotation/Resource.java
@@ -34,6 +34,8 @@ public @interface Resource {
     public String name() default "";
     /**
      * Uses generics since Common Annotations 1.2.
+     *
+     * @return The type for instances of this resource
      */
     public Class<?> type() default Object.class;
     public AuthenticationType authenticationType() default 
AuthenticationType.CONTAINER;
@@ -42,6 +44,8 @@ public @interface Resource {
     public String mappedName() default "";
     /**
      * @since Common Annotations 1.1
+     *
+     * @return The name of the entry, if any, to use for this resource
      */
     public String lookup() default "";
 }
diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
index 1f9471f..e24309c 100644
--- a/webapps/docs/changelog.xml
+++ b/webapps/docs/changelog.xml
@@ -63,6 +63,13 @@
       </fix>
     </changelog>
   </subsection>
+  <subsection name="Web Applications">
+    <changelog>
+      <docs>
+        Add Javadoc for the Common Annotations API implementation. (markt)
+      </docs>
+    </changelog>
+  </subsection>
   <subsection name="Other">
     <changelog>
       <scode>
diff --git a/webapps/docs/project.xml b/webapps/docs/project.xml
index 09cb4df..8e416ea 100644
--- a/webapps/docs/project.xml
+++ b/webapps/docs/project.xml
@@ -82,12 +82,14 @@
         <item name="Release Notes"         href="RELEASE-NOTES.txt"/>
         <item name="Configuration"         href="config/index.html"/>
         <item name="Tomcat Javadocs"       href="api/index.html"/>
-        <item name="Servlet Javadocs"      href="servletapi/index.html"/>
+        <item name="Servlet 4.0 Javadocs"  href="servletapi/index.html"/>
         <item name="JSP 2.3 Javadocs"      href="jspapi/index.html"/>
         <item name="EL 3.0 Javadocs"       href="elapi/index.html"/>
         <item name="WebSocket 1.1 Javadocs"
               href="websocketapi/index.html"/>
         <item name="JASPIC 1.1 Javadocs"   href="jaspicapi/index.html"/>
+        <item name="Common Annotations 1.3 Javadocs"
+              href="annotationapi/index.html"/>
         <item name="JK 1.2 Documentation"
               href="https://tomcat.apache.org/connectors-doc/"/>
     </menu>


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org