[tomcat] branch 8.5.x updated: Javadoc improvements

[ma...@apache.org]

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


The following commit(s) were added to refs/heads/8.5.x by this push:
     new 6b7132375d Javadoc improvements
6b7132375d is described below

commit 6b7132375d71a9f929e6f87004525fbd6ca5313e
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Nov 11 11:16:10 2022 +0000

    Javadoc improvements
---
 java/javax/annotation/Generated.java     | 2 ++
 java/javax/annotation/ManagedBean.java   | 2 ++
 java/javax/annotation/PostConstruct.java | 3 +++
 java/javax/annotation/PreDestroy.java    | 3 +++
 java/javax/annotation/Priority.java      | 3 +++
 java/javax/annotation/Resource.java      | 4 ++++
 java/javax/annotation/Resources.java     | 2 ++
 7 files changed, 19 insertions(+)

diff --git a/java/javax/annotation/Generated.java b/java/javax/annotation/Generated.java
index 9ba294292e..3625f65ad8 100644
--- a/java/javax/annotation/Generated.java
+++ b/java/javax/annotation/Generated.java
@@ -23,6 +23,8 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
+ * Used to identify generated code.
+ *
  * @since Common Annotations 1.0
  */
 @Documented
diff --git a/java/javax/annotation/ManagedBean.java b/java/javax/annotation/ManagedBean.java
index c0189a08cf..9383724474 100644
--- a/java/javax/annotation/ManagedBean.java
+++ b/java/javax/annotation/ManagedBean.java
@@ -22,6 +22,8 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
+ * Identifies a POJO as a managed bean.
+ *
  * @since Common Annotations 1.1
  */
 @Target(ElementType.TYPE)
diff --git a/java/javax/annotation/PostConstruct.java b/java/javax/annotation/PostConstruct.java
index 3ecb25b0ac..166aedbc6f 100644
--- a/java/javax/annotation/PostConstruct.java
+++ b/java/javax/annotation/PostConstruct.java
@@ -23,6 +23,9 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
+ * Added to a method required to be called after the object has been constructed
+ * and before it used.
+ *
  * @since Common Annotations 1.0
  */
 @Documented
diff --git a/java/javax/annotation/PreDestroy.java b/java/javax/annotation/PreDestroy.java
index eb1d578f1e..38bc4c6299 100644
--- a/java/javax/annotation/PreDestroy.java
+++ b/java/javax/annotation/PreDestroy.java
@@ -23,6 +23,9 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
+ * Added to a method required to be called once the object is no longer required
+ * and before it is discarded.
+ *
  * @since Common Annotations 1.0
  */
 @Documented
diff --git a/java/javax/annotation/Priority.java b/java/javax/annotation/Priority.java
index df757d91a5..9178b0921e 100644
--- a/java/javax/annotation/Priority.java
+++ b/java/javax/annotation/Priority.java
@@ -23,6 +23,9 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
+ * Used to define the order in which classes or parameters should be used. The
+ * annotated class or parameter defines how the prority value is used.
+ *
  * @since Common Annotations 1.2
  */
 @Documented
diff --git a/java/javax/annotation/Resource.java b/java/javax/annotation/Resource.java
index 91386520f9..214909128f 100644
--- a/java/javax/annotation/Resource.java
+++ b/java/javax/annotation/Resource.java
@@ -22,6 +22,10 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
+ * Indicates a resource required by the application. Annotated classes will be
+ * used as resources. Annotated fields and/or methods will have resources
+ * injected.
+ *
  * @since Common Annotations 1.0
  */
 @Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
diff --git a/java/javax/annotation/Resources.java b/java/javax/annotation/Resources.java
index 48d55c1079..5051fbe013 100644
--- a/java/javax/annotation/Resources.java
+++ b/java/javax/annotation/Resources.java
@@ -23,6 +23,8 @@ import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
 /**
+ * Used when multiple {@link Resource} annotations are required.
+ *
  * @since Common Annotations 1.0
  */
 @Documented


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