You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by re...@apache.org on 2022/12/19 15:41:50 UTC

[jackrabbit-oak] 02/06: OAK-10044: oak-core JDK11 Javadoc fixes

This is an automated email from the ASF dual-hosted git repository.

reschke pushed a commit to branch OAK-10044
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git

commit ba8db7ac3501a70e9af2477536feb698628bfd48
Author: Julian Reschke <ju...@gmx.de>
AuthorDate: Mon Dec 19 16:40:29 2022 +0100

    OAK-10044: oak-core JDK11 Javadoc fixes
---
 .../apache/jackrabbit/oak/plugins/metric/util/StatsProviderUtil.java | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/metric/util/StatsProviderUtil.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/metric/util/StatsProviderUtil.java
index 5e6c243354..498bffb1da 100644
--- a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/metric/util/StatsProviderUtil.java
+++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/metric/util/StatsProviderUtil.java
@@ -31,10 +31,11 @@ import java.util.function.BiFunction;
 
 /**
  * Util class to generate a name for Stats implementations that can be used for creating labels in prometheus.
- * Usage - StatsProviderUtil(<StatisticsProvider Object>).getHistoStats().apply(metricName, labels)
+ * <p>
+ * Usage - {@code StatsProviderUtil(<StatisticsProvider Object>).getHistoStats().apply(metricName, labels)}
  * where metricName is a String to denote the metric name and labels is map of label values.
  * Resultant metric will be created with a name as follows -
- * metricName;labelName1=labelValue1;labelName2=labelValue2
+ * {@code metricName;labelName1=labelValue1;labelName2=labelValue2}.
  * This can then be translated by a consuming alerting system like prometheus into metric name and labels separately.
  */
 public class StatsProviderUtil {