You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2022/11/11 11:16:28 UTC
[tomcat] branch main updated: Javadoc improvements
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/main by this push:
new d6f1802c06 Javadoc improvements
d6f1802c06 is described below
commit d6f1802c06342ab9031492b88ad7b4458bdc860b
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Nov 11 11:16:10 2022 +0000
Javadoc improvements
---
java/jakarta/annotation/Generated.java | 2 ++
java/jakarta/annotation/ManagedBean.java | 2 ++
java/jakarta/annotation/Nonnull.java | 3 ++-
java/jakarta/annotation/Nullable.java | 3 ++-
java/jakarta/annotation/PostConstruct.java | 3 +++
java/jakarta/annotation/PreDestroy.java | 3 +++
java/jakarta/annotation/Priority.java | 3 +++
java/jakarta/annotation/Resource.java | 4 ++++
java/jakarta/annotation/Resources.java | 2 ++
9 files changed, 23 insertions(+), 2 deletions(-)
diff --git a/java/jakarta/annotation/Generated.java b/java/jakarta/annotation/Generated.java
index ca4d99580c..8348127a84 100644
--- a/java/jakarta/annotation/Generated.java
+++ b/java/jakarta/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/jakarta/annotation/ManagedBean.java b/java/jakarta/annotation/ManagedBean.java
index ded1f047d4..0eac89251a 100644
--- a/java/jakarta/annotation/ManagedBean.java
+++ b/java/jakarta/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
*
* @deprecated This will be removed no earlier than Jakarta EE 11. Use CDI beans
diff --git a/java/jakarta/annotation/Nonnull.java b/java/jakarta/annotation/Nonnull.java
index 7fac3b8e57..b29d54e073 100644
--- a/java/jakarta/annotation/Nonnull.java
+++ b/java/jakarta/annotation/Nonnull.java
@@ -21,8 +21,9 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
- * @since Common Annotations 2.1
+ * Added to indicate an element may not be null.
*
+ * @since Common Annotations 2.1
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
diff --git a/java/jakarta/annotation/Nullable.java b/java/jakarta/annotation/Nullable.java
index 7ec2e1e715..de6be0e54d 100644
--- a/java/jakarta/annotation/Nullable.java
+++ b/java/jakarta/annotation/Nullable.java
@@ -21,8 +21,9 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
- * @since Common Annotations 2.1
+ * Added to indicate an element may be null.
*
+ * @since Common Annotations 2.1
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
diff --git a/java/jakarta/annotation/PostConstruct.java b/java/jakarta/annotation/PostConstruct.java
index 62e6096f81..9326bc1aee 100644
--- a/java/jakarta/annotation/PostConstruct.java
+++ b/java/jakarta/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/jakarta/annotation/PreDestroy.java b/java/jakarta/annotation/PreDestroy.java
index 6a07a95b8d..b25d2fe90a 100644
--- a/java/jakarta/annotation/PreDestroy.java
+++ b/java/jakarta/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/jakarta/annotation/Priority.java b/java/jakarta/annotation/Priority.java
index 53c7904080..918ac11365 100644
--- a/java/jakarta/annotation/Priority.java
+++ b/java/jakarta/annotation/Priority.java
@@ -21,6 +21,9 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
+ * 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/jakarta/annotation/Resource.java b/java/jakarta/annotation/Resource.java
index 6677224f82..a80c573938 100644
--- a/java/jakarta/annotation/Resource.java
+++ b/java/jakarta/annotation/Resource.java
@@ -23,6 +23,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/jakarta/annotation/Resources.java b/java/jakarta/annotation/Resources.java
index d595399e5c..17c154bda8 100644
--- a/java/jakarta/annotation/Resources.java
+++ b/java/jakarta/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