improve javadoc

api/src/main/java/jakarta/enterprise/context/BeforeDestroyed.java

@@ -54,28 +54,28 @@
      * Supports inline instantiation of the {@link BeforeDestroyed} qualifier.
      */
     public final static class Literal extends AnnotationLiteral<BeforeDestroyed> implements BeforeDestroyed {
-        /** Default RequestScoped literal */
+        /** Default BeforeDestroyed literal for the RequestScoped scope */
         public static final Literal REQUEST = of(RequestScoped.class);
-        /** Default ConversationScoped literal */
 
+        /** Default BeforeDestroyed literal for the ConversationScoped scope */
         public static final Literal CONVERSATION = of(ConversationScoped.class);
-        /** Default SessionScoped literal */
 
+        /** Default BeforeDestroyed literal for the SessionScoped scope */
         public static final Literal SESSION = of(SessionScoped.class);
-        /** Default ApplicationScoped literal */
 
+        /** Default BeforeDestroyed literal for the ApplicationScoped scope */
         public static final Literal APPLICATION = of(ApplicationScoped.class);
 
         private static final long serialVersionUID = 1L;
 
-        /** */
+        /** The scope annotation */
         private final Class<? extends Annotation> value;
 
         /**
-         * Obtain the literal of the provided scope annotation
+         * Obtain the literal for the provided scope annotation
          *
-         * @param value - the scope annotation
-         * @return a new Literal value for the provided scope annotation
+         * @param value the scope annotation
+         * @return a new literal value for the provided scope annotation
          */
         public static Literal of(Class<? extends Annotation> value) {
             return new Literal(value);

api/src/main/java/jakarta/enterprise/context/BusyConversationException.java

@@ -42,35 +42,35 @@ public class BusyConversationException extends ContextException {
     private static final long serialVersionUID = -3599813072560026919L;
 
     /**
-     * default ctor
+     * Creates the exception with no detail message or cause.
      */
     public BusyConversationException() {
         super();
     }
 
     /**
-     * Create exception with given message
+     * Creates the exception with given detail message.
      *
-     * @param message - context information
+     * @param message the detail message
      */
     public BusyConversationException(String message) {
         super(message);
     }
 
     /**
-     * Create exception with given cause
+     * Creates the exception with given cause.
      *
-     * @param cause - cause of exception
+     * @param cause the cause
      */
     public BusyConversationException(Throwable cause) {
         super(cause);
     }
 
     /**
-     * Create exception with given message and cause
+     * Creates the exception with given detail message and cause.
      *
-     * @param message - context information
-     * @param cause - cause of exception
+     * @param message the detail message
+     * @param cause the cause
      */
     public BusyConversationException(String message, Throwable cause) {
         super(message, cause);

api/src/main/java/jakarta/enterprise/context/ContextException.java

@@ -27,35 +27,35 @@ public class ContextException extends RuntimeException {
     private static final long serialVersionUID = -3599813072560026919L;
 
     /**
-     * default ctor
+     * Creates the exception with no detail message or cause.
      */
     public ContextException() {
         super();
     }
 
     /**
-     * Create exception with given message and cause
+     * Creates the exception with given detail message.
      *
-     * @param message - context information
+     * @param message the detail message
      */
     public ContextException(String message) {
         super(message);
     }
 
     /**
-     * Create exception with given message and cause
+     * Creates the exception with given cause.
      *
-     * @param cause - cause of exception
+     * @param cause the cause
      */
     public ContextException(Throwable cause) {
         super(cause);
     }
 
     /**
-     * Create exception with given message and cause
+     * Creates the exception with given detail message and cause.
      *
-     * @param message - context information
-     * @param cause - cause of exception
+     * @param message the detail message
+     * @param cause the cause
      */
     public ContextException(String message, Throwable cause) {
         super(message, cause);

api/src/main/java/jakarta/enterprise/context/ContextNotActiveException.java

@@ -33,35 +33,35 @@ public class ContextNotActiveException extends ContextException {
     private static final long serialVersionUID = -3599813072560026919L;
 
     /**
-     * Default ctor
+     * Creates the exception with no detail message or cause.
      */
     public ContextNotActiveException() {
         super();
     }
 
     /**
-     * Create exception with given message
+     * Creates the exception with given detail message.
      *
-     * @param message - context information
+     * @param message the detail message
      */
     public ContextNotActiveException(String message) {
         super(message);
     }
 
     /**
-     * Create exception with given cause
+     * Creates the exception with given cause.
      *
-     * @param cause - cause of exception
+     * @param cause the cause
      */
     public ContextNotActiveException(Throwable cause) {
         super(cause);
     }
 
     /**
-     * Create exception with given message and cause
+     * Creates the exception with given detail message and cause.
      *
-     * @param message - context information
-     * @param cause - cause of exception
+     * @param message the detail message
+     * @param cause the cause
      */
     public ContextNotActiveException(String message, Throwable cause) {
         super(message, cause);

api/src/main/java/jakarta/enterprise/context/Destroyed.java

@@ -55,27 +55,27 @@
      * @author Martin Kouba
      */
     public final static class Literal extends AnnotationLiteral<Destroyed> implements Destroyed {
-        /** Default RequestScoped literal */
+        /** Default Destroyed literal for the RequestScoped scope */
         public static final Literal REQUEST = of(RequestScoped.class);
-        /** Default ConversationScoped literal */
 
+        /** Default Destroyed literal for the ConversationScoped scope */
         public static final Literal CONVERSATION = of(ConversationScoped.class);
-        /** Default SessionScoped literal */
 
+        /** Default Destroyed literal for the SessionScoped scope */
         public static final Literal SESSION = of(SessionScoped.class);
-        /** Default ApplicationScoped literal */
 
+        /** Default Destroyed literal for the ApplicationScoped scope */
         public static final Literal APPLICATION = of(ApplicationScoped.class);
 
         private static final long serialVersionUID = 1L;
 
-        /** */
+        /** The scope annotation */
         private final Class<? extends Annotation> value;
 
         /**
          * Obtain the literal of the provided scope annotation
          *
-         * @param value - the scope annotation
+         * @param value the scope annotation
          * @return a new Literal value for the provided scope annotation
          */
         public static Literal of(Class<? extends Annotation> value) {

api/src/main/java/jakarta/enterprise/context/Initialized.java

@@ -55,27 +55,27 @@
      * @author Martin Kouba
      */
     public final static class Literal extends AnnotationLiteral<Initialized> implements Initialized {
-        /** Default RequestScoped literal */
+        /** Default Initialized literal for the RequestScoped scope */
         public static final Literal REQUEST = of(RequestScoped.class);
-        /** Default ConversationScoped literal */
 
+        /** Default Initialized literal for the ConversationScoped scope */
         public static final Literal CONVERSATION = of(ConversationScoped.class);
-        /** Default SessionScoped literal */
 
+        /** Default Initialized literal for the SessionScoped scope */
         public static final Literal SESSION = of(SessionScoped.class);
-        /** Default ApplicationScoped literal */
 
+        /** Default Initialized literal for the ApplicationScoped scope */
         public static final Literal APPLICATION = of(ApplicationScoped.class);
 
         private static final long serialVersionUID = 1L;
 
-        /** */
+        /** The scope annotation */
         private final Class<? extends Annotation> value;
 
         /**
          * Obtain the literal of the provided scope annotation
          *
-         * @param value - the scope annotation
+         * @param value the scope annotation
          * @return a new Literal value for the provided scope annotation
          */
         public static Literal of(Class<? extends Annotation> value) {

api/src/main/java/jakarta/enterprise/context/NonexistentConversationException.java

@@ -39,35 +39,35 @@ public class NonexistentConversationException extends ContextException {
     private static final long serialVersionUID = -3599813072560026919L;
 
     /**
-     * Default ctor
+     * Creates the exception with no detail message or cause.
      */
     public NonexistentConversationException() {
         super();
     }
 
     /**
-     * Create exception with given message
+     * Creates the exception with given detail message.
      *
-     * @param message - context information
+     * @param message the detail message
      */
     public NonexistentConversationException(String message) {
         super(message);
     }
 
     /**
-     * Create exception with given cause
+     * Creates the exception with given cause.
      *
-     * @param cause - cause of exception
+     * @param cause the cause
      */
     public NonexistentConversationException(Throwable cause) {
         super(cause);
     }
 
     /**
-     * Create exception with given message and cause
+     * Creates the exception with given detail message and cause.
      *
-     * @param message - context information
-     * @param cause - cause of exception
+     * @param message the detail message
+     * @param cause the cause
      */
     public NonexistentConversationException(String message, Throwable cause) {
         super(message, cause);

api/src/main/java/jakarta/enterprise/context/RequestScoped.java

@@ -95,7 +95,7 @@
      * @since 2.0
      */
     public final static class Literal extends AnnotationLiteral<RequestScoped> implements RequestScoped {
-        /** Default RequestScope literal */
+        /** Default RequestScoped literal */
         public static final Literal INSTANCE = new Literal();
 
         private static final long serialVersionUID = 1L;

api/src/main/java/jakarta/enterprise/event/NotificationOptions.java

@@ -75,16 +75,16 @@ interface Builder {
         /**
          * Set the notification executor
          *
-         * @param executor - {@linkplain Executor}
+         * @param executor the {@linkplain Executor}
          * @return this
          */
         Builder setExecutor(Executor executor);
 
         /**
          * Set an option value
          *
-         * @param optionName - name
-         * @param optionValue - value
+         * @param optionName option name
+         * @param optionValue option value
          * @return this
          */
         Builder set(String optionName, Object optionValue);

api/src/main/java/jakarta/enterprise/event/ObserverException.java

@@ -27,35 +27,35 @@ public class ObserverException extends RuntimeException {
     private static final long serialVersionUID = -801836224808304381L;
 
     /**
-     * Default ctor
+     * Creates the exception with no detail message or cause.
      */
     public ObserverException() {
 
     }
 
     /**
-     * Create exception with given message
+     * Creates the exception with given detail message.
      *
-     * @param message - context information
+     * @param message the detail message
      */
     public ObserverException(String message) {
         super(message);
     }
 
     /**
-     * Create exception with given cause
+     * Creates the exception with given cause.
      *
-     * @param cause - cause of exception
+     * @param cause the cause
      */
     public ObserverException(Throwable cause) {
         super(cause);
     }
 
     /**
-     * Create exception with given message and cause
+     * Creates the exception with given detail message and cause.
      *
-     * @param message - context information
-     * @param cause - cause of exception
+     * @param message the detail message
+     * @param cause the cause
      */
     public ObserverException(String message, Throwable cause) {
         super(message, cause);