Polish Javadoc for JMX support

Author: sbrannen

spring-context/src/main/java/org/springframework/jmx/export/annotation/AnnotationJmxAttributeSource.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2022 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -46,7 +46,7 @@
 import org.springframework.util.StringValueResolver;
 
 /**
- * Implementation of the {@code JmxAttributeSource} interface that
+ * Implementation of the {@link JmxAttributeSource} interface that
  * reads annotations and exposes the corresponding attributes.
  *
  * @author Rob Harrop

spring-context/src/main/java/org/springframework/jmx/export/annotation/AnnotationMBeanExporter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2022 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,7 +23,7 @@
 
 /**
  * Convenient subclass of Spring's standard {@link MBeanExporter},
- * activating Java 5 annotation usage for JMX exposure of Spring beans:
+ * activating annotation usage for JMX exposure of Spring beans:
  * {@link ManagedResource}, {@link ManagedAttribute}, {@link ManagedOperation}, etc.
  *
  * <p>Sets a {@link MetadataNamingStrategy} and a {@link MetadataMBeanInfoAssembler}

spring-context/src/main/java/org/springframework/jmx/export/annotation/ManagedMetric.java

@@ -27,7 +27,8 @@
 /**
  * Method-level annotation that indicates to expose a given bean property as a
  * JMX attribute, with added descriptor properties to indicate that it is a metric.
- * Only valid when used on a JavaBean getter.
+ *
+ * <p>Only valid when used on a JavaBean getter.
  *
  * @author Jennifer Hickey
  * @since 3.0

spring-context/src/main/java/org/springframework/jmx/export/annotation/ManagedNotification.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2022 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,10 +27,12 @@
 /**
  * Type-level annotation that indicates a JMX notification emitted by a bean.
  *
- * <p>As of Spring Framework 4.2.4, this annotation is declared as repeatable.
+ * <p>This annotation is a {@linkplain java.lang.annotation.Repeatable repeatable}
+ * annotation.
  *
  * @author Rob Harrop
  * @since 2.0
+ * @see ManagedNotifications
  * @see org.springframework.jmx.export.metadata.ManagedNotification
  */
 @Target(ElementType.TYPE)

spring-context/src/main/java/org/springframework/jmx/export/annotation/ManagedNotifications.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2022 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,8 +24,12 @@
 import java.lang.annotation.Target;
 
 /**
- * Type-level annotation that indicates JMX notifications emitted by a bean,
- * containing multiple {@link ManagedNotification ManagedNotifications}.
+ * Type-level annotation used as a container for one or more
+ * {@code @ManagedNotification} declarations.
+ *
+ * <p>Note, however, that use of the {@code @ManagedNotifications} container
+ * is completely optional since {@code @ManagedNotification} is a
+ * {@linkplain java.lang.annotation.Repeatable repeatable} annotation.
  *
  * @author Rob Harrop
  * @since 2.0

spring-context/src/main/java/org/springframework/jmx/export/annotation/ManagedOperation.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2022 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,9 +23,11 @@
 import java.lang.annotation.Target;
 
 /**
- * Method-level annotation that indicates to expose a given method as a
- * JMX operation, corresponding to the {@code ManagedOperation} attribute.
- * Only valid when used on a method that is not a JavaBean getter or setter.
+ * Method-level annotation that indicates to expose a given method as a JMX operation,
+ * corresponding to the {@link org.springframework.jmx.export.metadata.ManagedOperation}
+ * attribute.
+ *
+ * <p>Only valid when used on a method that is not a JavaBean getter or setter.
  *
  * @author Rob Harrop
  * @since 1.2

spring-context/src/main/java/org/springframework/jmx/export/annotation/ManagedOperationParameter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2022 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,15 +24,15 @@
 import java.lang.annotation.Target;
 
 /**
- * Method-level annotation used to provide metadata about operation parameters,
- * corresponding to a {@code ManagedOperationParameter} attribute.
- * Used as part of a {@link ManagedOperationParameters} annotation.
+ * Method-level annotation used to provide metadata about operation parameters, corresponding
+ * to a {@link org.springframework.jmx.export.metadata.ManagedOperationParameter} attribute.
  *
- * <p>As of Spring Framework 4.2.4, this annotation is declared as repeatable.
+ * <p>This annotation is a {@linkplain java.lang.annotation.Repeatable repeatable}
+ * annotation.
  *
  * @author Rob Harrop
  * @since 1.2
- * @see ManagedOperationParameters#value
+ * @see ManagedOperationParameters
  * @see org.springframework.jmx.export.metadata.ManagedOperationParameter
  */
 @Target(ElementType.METHOD)

spring-context/src/main/java/org/springframework/jmx/export/annotation/ManagedOperationParameters.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2022 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,8 +23,12 @@
 import java.lang.annotation.Target;
 
 /**
- * Method-level annotation used to provide metadata about operation parameters,
- * corresponding to an array of {@code ManagedOperationParameter} attributes.
+ * Method-level annotation used as a container for one or more
+ * {@code @ManagedOperationParameter} declarations.
+ *
+ * <p>Note, however, that use of the {@code @ManagedOperationParameters} container
+ * is completely optional since {@code @ManagedOperationParameter} is a
+ * {@linkplain java.lang.annotation.Repeatable repeatable} annotation.
  *
  * @author Rob Harrop
  * @since 1.2

spring-context/src/main/java/org/springframework/jmx/export/annotation/ManagedResource.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2022 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,8 +26,8 @@
 import org.springframework.core.annotation.AliasFor;
 
 /**
- * Class-level annotation that indicates to register instances of a class
- * with a JMX server, corresponding to the {@code ManagedResource} attribute.
+ * Class-level annotation that indicates to register instances of a class with a JMX server,
+ * corresponding to the {@link org.springframework.jmx.export.metadata.ManagedResource} attribute.
  *
  * <p><b>Note:</b> This annotation is marked as inherited, allowing for generic
  * management-aware base classes. In such a scenario, it is recommended to

spring-context/src/main/java/org/springframework/jmx/export/annotation/package-info.java

@@ -1,7 +1,8 @@
 /**
- * Java 5 annotations for MBean exposure.
- * Hooked into Spring's JMX export infrastructure
- * via a special JmxAttributeSource implementation.
+ * Annotations for MBean exposure.
+ *
+ * <p>Hooked into Spring's JMX export infrastructure via a special
+ * {@link org.springframework.jmx.export.metadata.JmxAttributeSource} implementation.
  */
 @NonNullApi
 @NonNullFields