Skip to content

Commit 8936aeb

Browse files
Craigacpjhalexand
authored andcommitted
Javadoc fixes.
1 parent 9bbdd46 commit 8936aeb

File tree

3 files changed

+9
-5
lines changed

3 files changed

+9
-5
lines changed

olcut-core/src/main/java/com/oracle/labs/mlrg/olcut/command/CommandGroup.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
/**
3232
* Essentially a marker interface for any class that provides
33-
* @Command commands for a command interpreter. Also provides a
33+
* {@code @Command} commands for a command interpreter. Also provides a
3434
* little helpful meta-data.
3535
*/
3636
public interface CommandGroup {

olcut-core/src/main/java/com/oracle/labs/mlrg/olcut/config/ConfigurableMXBean.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@ public interface ConfigurableMXBean {
7474

7575
/**
7676
* Sets the values in a property list.
77+
* @param property the property whose value we want to set
78+
* @param values the value that the property should be set to.
79+
* @return True if the values were set correctly.
7780
*/
7881
public boolean setValues(String property, String[] values);
7982

olcut-core/src/main/java/com/oracle/labs/mlrg/olcut/util/StopWatch.java

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ public long getLastStartMillis() {
145145
/**
146146
* Gets the average time per click (start/stop)
147147
* @deprecated Ambiguous units, use unit-specific get methods instead. Behavior of this method is undefined in subclasses.
148-
* @return
148+
* @return The average time.
149149
*/
150150
public double getAvgTime() {
151151
return getTime() / (double) clicks;
@@ -239,13 +239,14 @@ public static String formatMillisecondTime(long millis) {
239239
TimeUnit.MILLISECONDS.toHours(millis) % TimeUnit.DAYS.toHours(1),
240240
TimeUnit.MILLISECONDS.toMinutes(millis) % TimeUnit.HOURS.toMinutes(1),
241241
TimeUnit.MILLISECONDS.toSeconds(millis) % TimeUnit.MINUTES.toSeconds(1),
242-
TimeUnit.MILLISECONDS.toMillis(millis) % TimeUnit.SECONDS.toMillis(1)); }
242+
TimeUnit.MILLISECONDS.toMillis(millis) % TimeUnit.SECONDS.toMillis(1));
243+
}
243244

244245
/**
245246
* Creates a string representation to the nearest largest appropriate time unit.
246247
* @deprecated Use toString() instead which gives a more accurate, but still scoped appropriately time string
247-
* @param millis
248-
* @return
248+
* @param millis The time to convert to String.
249+
* @return A String representation.
249250
*/
250251
@Deprecated
251252
public static String toTimeString(double millis) {

0 commit comments

Comments
 (0)