Skip to content

Commit b2e1a19

Browse files
committed
corrected several JavaDoc issues
1 parent 3e230b5 commit b2e1a19

File tree

3 files changed

+13
-5
lines changed

3 files changed

+13
-5
lines changed

src/main/java/com/timgroup/statsd/NonBlockingStatsDClient.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ public void recordGaugeValue(String aspect, int value) {
203203
}
204204

205205
/**
206-
* Convenience method equivalent to {@link #recordGaugeValue(String)}.
206+
* Convenience method equivalent to {@link #recordGaugeValue(String, int)}.
207207
*/
208208
@Override
209209
public void gauge(String aspect, int value) {
@@ -226,7 +226,7 @@ public void recordExecutionTime(String aspect, int timeInMs) {
226226
}
227227

228228
/**
229-
* Convenience method equivalent to {@link #recordExecutionTime(String)}.
229+
* Convenience method equivalent to {@link #recordExecutionTime(String, int)}.
230230
*/
231231
@Override
232232
public void time(String aspect, int value) {

src/main/java/com/timgroup/statsd/StatsDClient.java

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@
44
* Describes a client connection to a StatsD server, which may be used to post metrics
55
* in the form of counters, timers, and gauges.
66
*
7+
* <p>Three key methods are provided for the submission of data-points for the application under
8+
* scrutiny:
9+
* <ul>
10+
* <li>{@link #incrementCounter} - adds one to the value of the specified named counter</li>
11+
* <li>{@link #recordGaugeValue} - records the latest fixed value for the specified named gauge</li>
12+
* <li>{@link #recordExecutionTime} - records an execution time in milliseconds for the specified named operation</li>
13+
* </ul>
14+
*
715
* @author Tom Denley
816
*
917
*/
@@ -70,7 +78,7 @@ public interface StatsDClient {
7078
void recordGaugeValue(String aspect, int value);
7179

7280
/**
73-
* Convenience method equivalent to {@link #recordGaugeValue(String)}.
81+
* Convenience method equivalent to {@link #recordGaugeValue(String, int)}.
7482
*/
7583
void gauge(String aspect, int value);
7684

@@ -87,7 +95,7 @@ public interface StatsDClient {
8795
void recordExecutionTime(String aspect, int timeInMs);
8896

8997
/**
90-
* Convenience method equivalent to {@link #recordExecutionTime(String)}.
98+
* Convenience method equivalent to {@link #recordExecutionTime(String, int)}.
9199
*/
92100
void time(String aspect, int value);
93101

src/main/java/com/timgroup/statsd/StatsDClientErrorHandler.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ public interface StatsDClientErrorHandler {
1414
* @param exception
1515
* the {@link Exception} that occurred
1616
*/
17-
void handle(Exception e);
17+
void handle(Exception exception);
1818

1919
}

0 commit comments

Comments
 (0)