diff options
author | Nasser Grainawi <nasser.grainawi@linaro.org> | 2022-10-05 11:01:57 -0600 |
---|---|---|
committer | Nasser Grainawi <nasser.grainawi@linaro.org> | 2022-10-05 11:01:57 -0600 |
commit | fa5787e919af21c5def0a27aa086b7b51fa7781e (patch) | |
tree | d4dc99dad8892b1127c5015a477f718f3ff31cbc | |
parent | dbd58a31ba96064cf78fda770ea96367a73d15f3 (diff) |
Fix javadoc summary for Google Java Style
The summary shouldn't use @return and should use "Returns".
[1] https://google.github.io/styleguide/javaguide.html#s7.2-summary-fragment
Change-Id: I631f0be5c048c2f93d62993c41583fb382d714ac
Release-Notes: skip
-rw-r--r-- | java/com/google/gerrit/metrics/MetricsReservoirConfig.java | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/java/com/google/gerrit/metrics/MetricsReservoirConfig.java b/java/com/google/gerrit/metrics/MetricsReservoirConfig.java index 455dfc0829..ca4cb09e1e 100644 --- a/java/com/google/gerrit/metrics/MetricsReservoirConfig.java +++ b/java/com/google/gerrit/metrics/MetricsReservoirConfig.java @@ -19,15 +19,15 @@ import java.time.Duration; /** Configuration of the Metrics' reservoir type and size. */ public interface MetricsReservoirConfig { - /** @return the reservoir type. */ + /** Returns the reservoir type. */ ReservoirType reservoirType(); - /** @return the reservoir window duration. */ + /** Returns the reservoir window duration. */ Duration reservoirWindow(); - /** @return the number of samples that the reservoir can contain */ + /** Returns the number of samples that the reservoir can contain */ int reservoirSize(); - /** @return the alpha parameter of the ExponentiallyDecaying reservoir */ + /** Returns the alpha parameter of the ExponentiallyDecaying reservoir */ double reservoirAlpha(); } |