Polish javadocs

grantkl · Oct 27, 2018 · 093dff8 · 093dff8
1 parent 382bbe3
commit 093dff8
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 27 deletions.
diff --git a/micrometer-core/src/main/java/io/micrometer/core/instrument/DistributionSummary.java b/micrometer-core/src/main/java/io/micrometer/core/instrument/DistributionSummary.java
@@ -139,8 +139,8 @@ public Builder tags(String... tags) {
         }
 
         /**
-         * @param tags Tags to add to the eventual counter.
-         * @return The counter builder with added tags.
+         * @param tags Tags to add to the eventual distribution summary.
+         * @return The distribution summary builder with added tags.
          */
         public Builder tags(Iterable<Tag> tags) {
             this.tags = this.tags.and(tags);
@@ -150,7 +150,7 @@ public Builder tags(Iterable<Tag> tags) {
         /**
          * @param key   The tag key.
          * @param value The tag value.
-         * @return The counter builder with a single added tag.
+         * @return The distribution summary builder with a single added tag.
          */
         public Builder tag(String key, String value) {
             this.tags = tags.and(key, value);

diff --git a/micrometer-core/src/main/java/io/micrometer/core/instrument/FunctionCounter.java b/micrometer-core/src/main/java/io/micrometer/core/instrument/FunctionCounter.java
@@ -74,8 +74,8 @@ public Builder<T> tags(String... tags) {
         }
 
         /**
-         * @param tags Tags to add to the eventual counter.
-         * @return The counter builder with added tags.
+         * @param tags Tags to add to the eventual function counter.
+         * @return The function counter builder with added tags.
          */
         public Builder<T> tags(Iterable<Tag> tags) {
             this.tags = this.tags.and(tags);
@@ -85,7 +85,7 @@ public Builder<T> tags(Iterable<Tag> tags) {
         /**
          * @param key   The tag key.
          * @param value The tag value.
-         * @return The counter builder with a single added tag.
+         * @return The function counter builder with a single added tag.
          */
         public Builder<T> tag(String key, String value) {
             this.tags = tags.and(key, value);

diff --git a/micrometer-core/src/main/java/io/micrometer/core/instrument/FunctionTimer.java b/micrometer-core/src/main/java/io/micrometer/core/instrument/FunctionTimer.java
@@ -105,8 +105,8 @@ public Builder<T> tags(String... tags) {
         }
 
         /**
-         * @param tags Tags to add to the eventual counter.
-         * @return The counter builder with added tags.
+         * @param tags Tags to add to the eventual function timer.
+         * @return The function timer builder with added tags.
          */
         public Builder<T> tags(Iterable<Tag> tags) {
             this.tags = this.tags.and(tags);
@@ -116,7 +116,7 @@ public Builder<T> tags(Iterable<Tag> tags) {
         /**
          * @param key   The tag key.
          * @param value The tag value.
-         * @return The counter builder with a single added tag.
+         * @return The function timer builder with a single added tag.
          */
         public Builder<T> tag(String key, String value) {
             this.tags = tags.and(key, value);

diff --git a/micrometer-core/src/main/java/io/micrometer/core/instrument/Gauge.java b/micrometer-core/src/main/java/io/micrometer/core/instrument/Gauge.java
@@ -110,8 +110,8 @@ public Builder<T> tags(String... tags) {
         }
 
         /**
-         * @param tags Tags to add to the eventual counter.
-         * @return The counter builder with added tags.
+         * @param tags Tags to add to the eventual gauge.
+         * @return The gauge builder with added tags.
          */
         public Builder<T> tags(Iterable<Tag> tags) {
             this.tags = this.tags.and(tags);
@@ -121,7 +121,7 @@ public Builder<T> tags(Iterable<Tag> tags) {
         /**
          * @param key   The tag key.
          * @param value The tag value.
-         * @return The counter builder with a single added tag.
+         * @return The gauge builder with a single added tag.
          */
         public Builder<T> tag(String key, String value) {
             this.tags = tags.and(key, value);

diff --git a/micrometer-core/src/main/java/io/micrometer/core/instrument/LongTaskTimer.java b/micrometer-core/src/main/java/io/micrometer/core/instrument/LongTaskTimer.java
@@ -206,8 +206,8 @@ public Builder tags(String... tags) {
         }
 
         /**
-         * @param tags Tags to add to the eventual counter.
-         * @return The counter builder with added tags.
+         * @param tags Tags to add to the eventual long task timer.
+         * @return The long task timer builder with added tags.
          */
         public Builder tags(Iterable<Tag> tags) {
             this.tags = this.tags.and(tags);
@@ -217,7 +217,7 @@ public Builder tags(Iterable<Tag> tags) {
         /**
          * @param key   The tag key.
          * @param value The tag value.
-         * @return The counter builder with a single added tag.
+         * @return The long task timer builder with a single added tag.
          */
         public Builder tag(String key, String value) {
             this.tags = tags.and(key, value);

diff --git a/micrometer-core/src/main/java/io/micrometer/core/instrument/MultiGauge.java b/micrometer-core/src/main/java/io/micrometer/core/instrument/MultiGauge.java
@@ -140,8 +140,8 @@ public Builder tags(String... tags) {
         }
 
         /**
-         * @param tags Tags to add to the eventual counter.
-         * @return The counter builder with added tags.
+         * @param tags Tags to add to the eventual gauge.
+         * @return The gauge builder with added tags.
          */
         public Builder tags(Iterable<Tag> tags) {
             this.tags = this.tags.and(tags);
@@ -151,7 +151,7 @@ public Builder tags(Iterable<Tag> tags) {
         /**
          * @param key   The tag key.
          * @param value The tag value.
-         * @return The counter builder with a single added tag.
+         * @return The gauge builder with a single added tag.
          */
         public Builder tag(String key, String value) {
             this.tags = tags.and(key, value);

diff --git a/micrometer-core/src/main/java/io/micrometer/core/instrument/TimeGauge.java b/micrometer-core/src/main/java/io/micrometer/core/instrument/TimeGauge.java
@@ -71,15 +71,15 @@ private Builder(String name, @Nullable T obj, TimeUnit fUnits, ToDoubleFunction<
 
         /**
          * @param tags Must be an even number of arguments representing key/value pairs of tags.
-         * @return This builder.
+         * @return This time gauge builder.
          */
         public Builder<T> tags(String... tags) {
             return tags(Tags.of(tags));
         }
 
         /**
-         * @param tags Tags to add to the eventual counter.
-         * @return The counter builder with added tags.
+         * @param tags Tags to add to the eventual time gauge.
+         * @return The time gauge builder with added tags.
          */
         public Builder<T> tags(Iterable<Tag> tags) {
             this.tags = this.tags.and(tags);
@@ -89,7 +89,7 @@ public Builder<T> tags(Iterable<Tag> tags) {
         /**
          * @param key   The tag key.
          * @param value The tag value.
-         * @return The counter builder with a single added tag.
+         * @return The time gauge builder with a single added tag.
          */
         public Builder<T> tag(String key, String value) {
             this.tags = tags.and(key, value);

diff --git a/micrometer-core/src/main/java/io/micrometer/core/instrument/Timer.java b/micrometer-core/src/main/java/io/micrometer/core/instrument/Timer.java
@@ -90,7 +90,7 @@ static Builder builder(Timed timed, String defaultName) {
     }
 
     /**
-     * Updates the statistics kept by the counter with the specified amount.
+     * Updates the statistics kept by the timer with the specified amount.
      *
      * @param amount Duration of a single event being measured by this timer. If the amount is less than 0
      *               the value will be dropped.
@@ -99,7 +99,7 @@ static Builder builder(Timed timed, String defaultName) {
     void record(long amount, TimeUnit unit);
 
     /**
-     * Updates the statistics kept by the counter with the specified amount.
+     * Updates the statistics kept by the timer with the specified amount.
      *
      * @param duration Duration of a single event being measured by this timer.
      */
@@ -286,8 +286,8 @@ public Builder tags(String... tags) {
         }
 
         /**
-         * @param tags Tags to add to the eventual counter.
-         * @return The counter builder with added tags.
+         * @param tags Tags to add to the eventual timer.
+         * @return The timer builder with added tags.
          */
         public Builder tags(Iterable<Tag> tags) {
             this.tags = this.tags.and(tags);
@@ -297,7 +297,7 @@ public Builder tags(Iterable<Tag> tags) {
         /**
          * @param key   The tag key.
          * @param value The tag value.
-         * @return The counter builder with a single added tag.
+         * @return The timer builder with a single added tag.
          */
         public Builder tag(String key, String value) {
             this.tags = tags.and(key, value);