fix javadoc warnings in CDI Language Model API

jakartaee · Feb 27, 2024 · 4856e19 · 4856e19
1 parent 0dd76aa
commit 4856e19
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 8 deletions.
diff --git a/lang-model/src/main/java/jakarta/enterprise/lang/model/declarations/DeclarationInfo.java b/lang-model/src/main/java/jakarta/enterprise/lang/model/declarations/DeclarationInfo.java
@@ -26,6 +26,7 @@
  * <li>{@linkplain FieldInfo fields}</li>
  * <li>{@linkplain MethodInfo methods}, including constructors</li>
  * <li>{@linkplain ParameterInfo method parameters}, including constructor parameters</li>
+ * <li>{@linkplain RecordComponentInfo record components}</li>
  * </ul>
  *
  * @since 4.0
@@ -51,12 +52,33 @@ default Type asType() {
         throw new IllegalStateException("Not a type");
     }
 
+    /**
+     * The declaration kind: package, class, method, parameter, field, record component.
+     */
     enum Kind {
+        /**
+         * Package
+         */
         PACKAGE,
+        /**
+         * Class, interface, enum, annotation, or record
+         */
         CLASS,
+        /**
+         * Method or constructor
+         */
         METHOD,
+        /**
+         * Method parameter or constructor parameter
+         */
         PARAMETER,
+        /**
+         * Field
+         */
         FIELD,
+        /**
+         * Record component
+         */
         RECORD_COMPONENT,
     }
 

diff --git a/lang-model/src/main/java/jakarta/enterprise/lang/model/types/PrimitiveType.java b/lang-model/src/main/java/jakarta/enterprise/lang/model/types/PrimitiveType.java
@@ -30,14 +30,41 @@
  * @since 4.0
  */
 public interface PrimitiveType extends Type {
+    /**
+     * The primitive type kind: boolean, byte, short, int, long, float, double, char
+     */
     enum PrimitiveKind {
+        /**
+         * The {@code boolean} primitive type
+         */
         BOOLEAN,
+        /**
+         * The {@code byte} primitive type
+         */
         BYTE,
+        /**
+         * The {@code short} primitive type
+         */
         SHORT,
+        /**
+         * The {@code int} primitive type
+         */
         INT,
+        /**
+         * The {@code long} primitive type
+         */
         LONG,
+        /**
+         * The {@code float} primitive type
+         */
         FLOAT,
+        /**
+         * The {@code double} primitive type
+         */
         DOUBLE,
+        /**
+         * The {@code char} primitive type
+         */
         CHAR,
     }
 

diff --git a/lang-model/src/main/java/jakarta/enterprise/lang/model/types/Type.java b/lang-model/src/main/java/jakarta/enterprise/lang/model/types/Type.java
@@ -68,22 +68,28 @@ default Type asType() {
         return this;
     }
 
+    /**
+     * The type kind: void, primitive, class, array, parameterized type, type variable, wildcard type
+     */
     enum Kind {
-        /** E.g. when method returns {@code void}. */
+        /** The void pseudo-type, e.g. when method returns {@code void}. */
         VOID,
-        /** E.g. when method returns {@code int}. */
+        /** A primitive type, e.g. when method returns {@code int}. */
         PRIMITIVE,
-        /** E.g. when method returns {@code String}. */
+        /** A class type, e.g. when method returns {@code String}. */
         CLASS,
-        /** E.g. when method returns {@code int[]} or {@code String[][]}. */
+        /** An array type, e.g. when method returns {@code int[]} or {@code String[][]}. */
         ARRAY,
-        /** E.g. when method returns {@code List<String>}. */
+        /** A parameterized type, e.g. when method returns {@code List<String>}. */
         PARAMETERIZED_TYPE,
-        /** E.g. when method returns {@code T} and {@code T} is a type parameter of the declaring class. */
+        /**
+         * A type variable, e.g. when method returns {@code T} and {@code T} is a type parameter
+         * of the declaring class.
+         */
         TYPE_VARIABLE,
         /**
-         * E.g. when method returns {@code List<? extends Number>}. The kind of such type is {@code PARAMETERIZED_TYPE},
-         * but the first (and only) type argument is a {@code WILDCARD_TYPE}.
+         * A wildcard type, e.g. when method returns {@code List<? extends Number>}. The kind of such type
+         * is {@code PARAMETERIZED_TYPE}, but the first (and only) type argument is a {@code WILDCARD_TYPE}.
          */
         WILDCARD_TYPE,
     }

diff --git a/lang-model/src/main/java/module-info.java b/lang-model/src/main/java/module-info.java
@@ -11,6 +11,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * The {@code jakarta.cdi.lang.model} module; defines the CDI Language Model API exported packages
+ */
 module jakarta.cdi.lang.model {
     exports jakarta.enterprise.lang.model;
     exports jakarta.enterprise.lang.model.declarations;