Skip to content

Commit 6636b64

Browse files
authored
Fix javadoc compilation warnings (#3)
1 parent 45bb3f2 commit 6636b64

File tree

3 files changed

+6
-11
lines changed

3 files changed

+6
-11
lines changed

contrib/src/main/java/com/google/monitoring/metrics/contrib/DistributionMetricSubject.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
import javax.annotation.Nullable;
3232

3333
/**
34-
* Truth subject for the {@link Metric<Distribution>} class.
34+
* Truth subject for {@link Distribution} {@link Metric} instances.
3535
*
3636
* <p>For use with the Google <a href="https://google.github.io/truth/">Truth</a> framework. Usage:
3737
*
@@ -53,8 +53,7 @@
5353
public final class DistributionMetricSubject
5454
extends AbstractMetricSubject<Distribution, DistributionMetricSubject> {
5555

56-
/** {@link Subject.Factory} for assertions about {@link Metric<Distribution>} objects. */
57-
/** Static assertThat({@link Metric<Distribution>}) shortcut method. */
56+
/** Static shortcut method for {@link Distribution} {@link Metric} objects. */
5857
public static DistributionMetricSubject assertThat(@Nullable Metric<Distribution> metric) {
5958
return assertAbout(DistributionMetricSubject::new).that(metric);
6059
}

contrib/src/main/java/com/google/monitoring/metrics/contrib/LongMetricSubject.java

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import javax.annotation.Nullable;
2424

2525
/**
26-
* Truth subject for the {@link Metric<Long>} class.
26+
* Truth subject for {@link Long} {@link Metric} instances.
2727
*
2828
* <p>For use with the Google <a href="https://google.github.io/truth/">Truth</a> framework. Usage:
2929
*
@@ -44,11 +44,7 @@
4444
*/
4545
public final class LongMetricSubject extends AbstractMetricSubject<Long, LongMetricSubject> {
4646

47-
/**
48-
* Static assertThat({@link Metric<Long>}) shortcut method.
49-
*
50-
* @see Subject.Factory for assertions about {@link Metric<Long>} objects.
51-
*/
47+
/** Static shortcut method for {@link Long} metrics. */
5248
public static LongMetricSubject assertThat(@Nullable Metric<Long> metric) {
5349
return assertAbout(LongMetricSubject::new).that(metric);
5450
}

metrics/src/main/java/com/google/monitoring/metrics/MetricRegistry.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public interface MetricRegistry {
4040
* @param metricCallback {@link Supplier} to compute the on-demand values of the metric. The
4141
* function should be lightweight to compute and must be thread-safe. The map keys, which are
4242
* lists of strings, must match in quantity and order with the provided labels.
43-
* @param valueClass type hint to allow for compile-time encoding. Must match <V>.
43+
* @param valueClass type hint to allow for compile-time encoding. Must match {@code V}.
4444
* @param <V> value type of the metric. Must be one of {@link Boolean}, {@link Double}, {@link
4545
* Long}, or {@link String}.
4646
* @throws IllegalStateException if a metric of the same name is already registered.
@@ -68,7 +68,7 @@ <V> Metric<V> newGauge(
6868
* @param valueDisplayName human readable description of the metric's value type.
6969
* @param labels list of the metric's labels. The labels (if there are any) must be of type
7070
* STRING.
71-
* @param valueClass type hint to allow for compile-time encoding. Must match <V>.
71+
* @param valueClass type hint to allow for compile-time encoding. Must match {@code V}.
7272
* @param <V> value type of the metric. Must be one of {@link Boolean}, {@link Double}, {@link
7373
* Long}, or {@link String}.
7474
* @throws IllegalStateException if a metric of the same name is already registered.

0 commit comments

Comments
 (0)