Skip to content

Commit 0fecad9

Browse files
committed
Slight JavaDoc cleanups
1 parent 126fe16 commit 0fecad9

3 files changed

Lines changed: 12 additions & 13 deletions

File tree

src/main/java/nl/rug/jbi/jsm/core/calculator/MetricResult.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ public class MetricResult {
1919
/**
2020
* Protected superclass for sub-classing.
2121
*
22-
* @param identifier Identifier of the associated resource
22+
* @param identifier Identifier of the associated resource
2323
* @param metricClass Metric for which this is a result
24-
* @param scope Scope that this metric belongs in.
25-
* @param value The result value.
24+
* @param scope Scope that this metric belongs in.
25+
* @param value The result value.
2626
* @throws java.lang.NullPointerException If anything but the value is NULL
2727
*/
2828
protected MetricResult(
@@ -42,8 +42,8 @@ protected MetricResult(
4242
* scope from the given metric.
4343
*
4444
* @param identifier Identifier of the associated resource
45-
* @param metric Metric for which this is a result
46-
* @param value The result value.
45+
* @param metric Metric for which this is a result
46+
* @param value The result value.
4747
* @return The result for the given values.
4848
* @throws java.lang.NullPointerException If anything but the value is NULL
4949
*/
@@ -54,10 +54,10 @@ public static MetricResult getResult(final String identifier, final BaseMetric m
5454
/**
5555
* Construct a result for the given identifier-metric pair, in the given scope and with the given value.
5656
*
57-
* @param identifier Identifier of the associated resource
57+
* @param identifier Identifier of the associated resource
5858
* @param metricClass Metric for which this is a result
59-
* @param scope Scope that this metric belongs in.
60-
* @param value The result value.
59+
* @param scope Scope that this metric belongs in.
60+
* @param value The result value.
6161
* @return The result for the given values.
6262
* @throws java.lang.NullPointerException If anything but the value is NULL
6363
*/

src/main/java/nl/rug/jbi/jsm/core/calculator/MetricState.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public String getIdentifier() {
7272
/**
7373
* Get a value from the internal map, use of {@link #getValue(String, com.google.common.base.Supplier)} or
7474
* {@link #getValueOrCreate(String, com.google.common.base.Supplier)} is recommended.
75-
**
75+
*
7676
* @param key Unique key by which the value can be identified.
7777
* @param <T> Type of the given object.
7878
* @return The object if it exists within this state, otherwise NULL
@@ -87,7 +87,7 @@ public <T> T getValue(final String key) {
8787
/**
8888
* Get a value from the internal store, if that value doesn't exist the result from the given
8989
* {@link com.google.common.base.Supplier#get()} is returned.
90-
**
90+
*
9191
* @param key Unique key by which the value can be identified.
9292
* @param def Default value supplier if the value doesn't exist within the store.
9393
* @param <T> Type of the given object.
@@ -104,7 +104,6 @@ public <T> T getValue(final String key, final Supplier<T> def) {
104104
/**
105105
* Same as {@link #getValue(String, com.google.common.base.Supplier)}, but if the value is missing the default value
106106
* is immediately inserted into the store at the same time.
107-
* *
108107
*
109108
* @param key Unique key by which the value can be identified.
110109
* @param def Default value supplier if the value doesn't exist within the store.

src/main/java/nl/rug/jbi/jsm/core/calculator/ProducerMetric.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public abstract class ProducerMetric extends BaseMetric {
1818
private final MetricScope produceScope;
1919

2020
/**
21-
* @param dataScope The operating scope of this metric.
21+
* @param dataScope The operating scope of this metric.
2222
* @param produceScope Scope that the produce will belong to.
2323
*/
2424
public ProducerMetric(final MetricScope dataScope, final MetricScope produceScope) {
@@ -66,7 +66,7 @@ public class Produce {
6666
private final Object produce;
6767

6868
/**
69-
* @param target Identifier of the target that the data belongs to.
69+
* @param target Identifier of the target that the data belongs to.
7070
* @param produce Data to be delivered to metrics requesting it.
7171
* @throws java.lang.NullPointerException of either of the parameters is NULL.
7272
*/

0 commit comments

Comments
 (0)