Doc + copyright

eclipse · Aug 5, 2022 · 23635ae · 23635ae
1 parent 1b9fb14
commit 23635ae
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 14 deletions.
diff --git a/api/src/main/java/org/eclipse/microprofile/metrics/annotation/Gauge.java b/api/src/main/java/org/eclipse/microprofile/metrics/annotation/Gauge.java
@@ -1,6 +1,6 @@
 /*
  **********************************************************************
- * Copyright (c) 2017 Contributors to the Eclipse Foundation
+ * Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
  *               2010-2013 Coda Hale, Yammer.com
  *
  * See the NOTICES file(s) distributed with this work for additional

diff --git a/api/src/main/java/org/eclipse/microprofile/metrics/annotation/Metric.java b/api/src/main/java/org/eclipse/microprofile/metrics/annotation/Metric.java
@@ -1,6 +1,6 @@
 /*
  **********************************************************************
- * Copyright (c) 2017, 2019 Contributors to the Eclipse Foundation
+ * Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
  *               2012 Ryan W Tenney (ryan@10e.us)
  *
  * See the NOTICES file(s) distributed with this work for additional

diff --git a/api/src/main/java/org/eclipse/microprofile/metrics/annotation/RegistryType.java b/api/src/main/java/org/eclipse/microprofile/metrics/annotation/RegistryType.java
@@ -1,6 +1,6 @@
 /*
  **********************************************************************
- * Copyright (c) 2017 Contributors to the Eclipse Foundation
+ * Copyright (c) 2017, 2022 Contributors to the Eclipse Foundation
  *
  * See the NOTICES file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -30,25 +30,26 @@
 import org.eclipse.microprofile.metrics.MetricRegistry;
 
 /**
- * The type of Metric Registry to inject.
+ * The scope of Metric Registry to inject.
  * <p>
  * This can be used to obtain the respective scoped {@link MetricRegistry}:
  * </p>
  * 
  * <pre>
  * <code>
  *      {@literal @}Inject
- *      {@literal @}RegistryType(type=MetricRegistry.APPLICATION_SCOPE)
+ *      {@literal @}RegistryType(scope=MetricRegistry.APPLICATION_SCOPE)
  *      MetricRegistry appRegistry;
  * 
  *      {@literal @}Inject
- *      {@literal @}RegistryType(type="customScope")
- *      MetricRegistry appRegistry;
+ *      {@literal @}RegistryType(scope="customScope")
+ *      MetricRegistry customRegistry;
+ * 
  * </code>
  * </pre>
  *
  * see {@link MetricRegistry.APPLICATION_SCOPE}, {@link MetricRegistry.BASE_SCOPE} and
- * {@link MetricRegistry.VEDNOR_SCOPE}
+ * {@link MetricRegistry.VENDOR_SCOPE}
  *
  * @author Raymond Lam
  *
@@ -64,7 +65,7 @@
      *         {@code application}, {@code base} and {@code vendor} scopes as part of the runtime.
      * 
      *         see {@link MetricRegistry.APPLICATION_SCOPE}, {@link MetricRegistry.BASE_SCOPE} and
-     *         {@link MetricRegistry.VEDNOR_SCOPE}
+     *         {@link MetricRegistry.VENDOR_SCOPE}
      */
     String scope() default MetricRegistry.APPLICATION_SCOPE;
 }
diff --git a/api/src/main/java/org/eclipse/microprofile/metrics/annotation/package-info.java b/api/src/main/java/org/eclipse/microprofile/metrics/annotation/package-info.java
@@ -70,17 +70,17 @@
  * </pre>
  *
  *
- * <h2>CDI Qualifier</h2>
+ * <h2>RegistryType annotation</h2>
  * <p>
  * The {@link org.eclipse.microprofile.metrics.annotation.RegistryType RegistryType} is used to identify which
- * <code>MetricRegistry</code> (Application, Base, or Vendor) should be injected. By default, no
- * <code>RegistryType</code> will inject the application <code>MetricRegistry</code>.
+ * <code>MetricRegistry</code> (Application, Base, Vendor or a user defined scope) should be injected. By default
+ * no <code>RegistryType</code> will inject the application <code>MetricRegistry</code>.
  *
  * <pre>
  * <code>
  *      {@literal @}Inject
- *      {@literal @}RegistryType(type=MetricRegistry.BASE_SCOPE)
- *      MetricRegistry baseRegistry;
+ *      {@literal @}RegistryType(scope=MetricRegistry.APPLICATION_SCOPE)
+ *      MetricRegistry appRegistry;
  * </code>
  * </pre>
  *