Skip to content

Commit 3cda222

Browse files
ctruedengselzer
authored andcommitted
Fix Progress javadoc errors
1 parent e12f137 commit 3cda222

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

scijava-progress/src/main/java/org/scijava/progress/Progress.java

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,11 @@ protected ArrayDeque<Task> initialValue() {
9393
};
9494

9595
/**
96-
* Records {@link Consumer<Task>} {@code l} as a callback for all progressible
97-
* {@link Object}s
96+
* Invokes the given {@link Consumer} as a callback for all progressible
97+
* {@link Object}s.
9898
*
99-
* @param l a {@link Consumer<Task>} that would like to know about the
100-
* progress of {@code progressible} {@link Object}s
99+
* @param l a {@link Consumer} that would like to know about the progress of
100+
* {@code progressible} {@link Object}s
101101
*/
102102
public static void addGlobalListener(Consumer<Task> l) {
103103
if (!globalListeners.contains(l)) {
@@ -106,12 +106,12 @@ public static void addGlobalListener(Consumer<Task> l) {
106106
}
107107

108108
/**
109-
* Records {@link Consumer<Task>} {@code l} as a callback for progressible
110-
* {@link Object} {@code progressible}
109+
* Invokes the given {@link Consumer} as a callback for the specified
110+
* progressible {@link Object}.
111111
*
112112
* @param progressible an {@link Object} that reports its progress
113-
* @param l a {@link Consumer<Task>} that would like to know about the
114-
* progress of {@code progressible}
113+
* @param l a {@link Consumer} that would like to know about the progress of
114+
* {@code progressible}
115115
*/
116116
public static void addListener(Object progressible, Consumer<Task> l) {
117117
if (!progressibleListeners.containsKey(progressible)) {
@@ -128,7 +128,7 @@ private static synchronized void createListenerList(Object progressible) {
128128
/**
129129
* Completes the current task on this {@link Thread}'s execution hierarchy,
130130
* removing it in the process. This method also takes care to ping relevant
131-
* {@link Consumer<Task>}s.
131+
* {@link Consumer}s.
132132
*
133133
* @see Task#complete()
134134
*/
@@ -195,8 +195,8 @@ public static void register(final Object progressible,
195195
}
196196

197197
/**
198-
* Activates all callback {@link Consumer <Task>}s listening for progress
199-
* updates on executions of {@code o}
198+
* Activates all callback {@link Consumer}s listening for progress updates on
199+
* executions of {@code o}
200200
*
201201
* @param task an {@link Object} reporting its progress.
202202
*/
@@ -233,7 +233,7 @@ public static Task currentTask() {
233233

234234
/**
235235
* Updates the progress of the current {@link Task}, pinging any interested
236-
* {@link Consumer<Task>}s.
236+
* {@link Consumer}s.
237237
*
238238
* @see Task#update(long)
239239
*/
@@ -243,7 +243,7 @@ public static void update() {
243243

244244
/**
245245
* Updates the progress of the current {@link Task}, pinging any interested
246-
* {@link Consumer<Task>}s.
246+
* {@link Consumer}s.
247247
*
248248
* @param elements the number of elements completed in the current stage.
249249
* @see Task#update(long)
@@ -254,7 +254,7 @@ public static void update(long elements) {
254254

255255
/**
256256
* Updates the progress of the provided {@link Task}, pinging any interested
257-
* {@link Consumer<Task>}s.
257+
* {@link Consumer}s.
258258
*
259259
* @param numElements the number of elements completed in the current stage.
260260
* @param task the {@link Task} to update
@@ -267,7 +267,7 @@ public static void update(final long numElements, final Task task) {
267267

268268
/**
269269
* Sets the status of the current {@link Task}, pinging any interested
270-
* {@link Consumer<Task>}s.
270+
* {@link Consumer}s.
271271
*
272272
* @see Task#setStatus(String)
273273
*/

0 commit comments

Comments
 (0)