Skip to content

Fix javadoc compilation warnings #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cornmander merged 1 commit into from
Dec 20, 2017
Merged

Fix javadoc compilation warnings #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions contrib/src/main/java/com/google/monitoring/metrics/contrib/DistributionMetricSubject.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
import javax.annotation.Nullable;

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

/** {@link Subject.Factory} for assertions about {@link Metric<Distribution>} objects. */
/** Static assertThat({@link Metric<Distribution>}) shortcut method. */
/** Static shortcut method for {@link Distribution} {@link Metric} objects. */
public static DistributionMetricSubject assertThat(@Nullable Metric<Distribution> metric) {
return assertAbout(DistributionMetricSubject::new).that(metric);
}
Expand Down
8 changes: 2 additions & 6 deletions contrib/src/main/java/com/google/monitoring/metrics/contrib/LongMetricSubject.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import javax.annotation.Nullable;

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

/**
* Static assertThat({@link Metric<Long>}) shortcut method.
*
* @see Subject.Factory for assertions about {@link Metric<Long>} objects.
*/
/** Static shortcut method for {@link Long} metrics. */
public static LongMetricSubject assertThat(@Nullable Metric<Long> metric) {
return assertAbout(LongMetricSubject::new).that(metric);
}
Expand Down
4 changes: 2 additions & 2 deletions metrics/src/main/java/com/google/monitoring/metrics/MetricRegistry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public interface MetricRegistry {
* @param metricCallback {@link Supplier} to compute the on-demand values of the metric. The
* function should be lightweight to compute and must be thread-safe. The map keys, which are
* lists of strings, must match in quantity and order with the provided labels.
* @param valueClass type hint to allow for compile-time encoding. Must match <V>.
* @param valueClass type hint to allow for compile-time encoding. Must match {@code V}.
* @param <V> value type of the metric. Must be one of {@link Boolean}, {@link Double}, {@link
* Long}, or {@link String}.
* @throws IllegalStateException if a metric of the same name is already registered.
Expand Down Expand Up @@ -68,7 +68,7 @@ <V> Metric<V> newGauge(
* @param valueDisplayName human readable description of the metric's value type.
* @param labels list of the metric's labels. The labels (if there are any) must be of type
* STRING.
* @param valueClass type hint to allow for compile-time encoding. Must match <V>.
* @param valueClass type hint to allow for compile-time encoding. Must match {@code V}.
* @param <V> value type of the metric. Must be one of {@link Boolean}, {@link Double}, {@link
* Long}, or {@link String}.
* @throws IllegalStateException if a metric of the same name is already registered.
Expand Down