--- jsr166/src/jdk7/java/util/concurrent/CompletionService.java 2012/12/16 20:55:15 1.1 +++ jsr166/src/jdk7/java/util/concurrent/CompletionService.java 2013/02/05 20:09:33 1.3 @@ -9,17 +9,17 @@ package java.util.concurrent; /** * A service that decouples the production of new asynchronous tasks * from the consumption of the results of completed tasks. Producers - * submit tasks for execution. Consumers take + * {@code submit} tasks for execution. Consumers {@code take} * completed tasks and process their results in the order they - * complete. A CompletionService can for example be used to + * complete. A {@code CompletionService} can for example be used to * manage asynchronous I/O, in which tasks that perform reads are * submitted in one part of a program or system, and then acted upon * in a different part of the program when the reads complete, * possibly in a different order than they were requested. * - *

Typically, a CompletionService relies on a separate + *

Typically, a {@code CompletionService} relies on a separate * {@link Executor} to actually execute the tasks, in which case the - * CompletionService only manages an internal completion + * {@code CompletionService} only manages an internal completion * queue. The {@link ExecutorCompletionService} class provides an * implementation of this approach. * @@ -51,7 +51,7 @@ public interface CompletionService { * @param task the task to submit * @param result the result to return upon successful completion * @return a Future representing pending completion of the task, - * and whose get() method will return the given + * and whose {@code get()} method will return the given * result value upon completion * @throws RejectedExecutionException if the task cannot be * scheduled for execution @@ -70,10 +70,10 @@ public interface CompletionService { /** * Retrieves and removes the Future representing the next - * completed task or null if none are present. + * completed task, or {@code null} if none are present. * * @return the Future representing the next completed task, or - * null if none are present + * {@code null} if none are present */ Future poll(); @@ -83,11 +83,11 @@ public interface CompletionService { * time if none are yet present. * * @param timeout how long to wait before giving up, in units of - * unit - * @param unit a TimeUnit determining how to interpret the - * timeout parameter + * {@code unit} + * @param unit a {@code TimeUnit} determining how to interpret the + * {@code timeout} parameter * @return the Future representing the next completed task or - * null if the specified waiting time elapses + * {@code null} if the specified waiting time elapses * before one is present * @throws InterruptedException if interrupted while waiting */