WorkerManager: Correct javadoc for "stop". (#17279)

The javadoc had a factual error: Dart's implementation does not in
fact always return immediately.
This commit is contained in:
Gian Merlino 2024-10-08 03:19:43 -07:00 committed by GitHub
parent 0a279e634a
commit 152330c5a8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 3 deletions

View File

@ -85,9 +85,11 @@ public interface WorkerManager
/** /**
* Stop all workers. * Stop all workers.
* *
* The task-based implementation blocks until all tasks exit. Dart's implementation queues workers for stopping in * The task-based implementation blocks until all tasks exit. Dart's implementation sends stop commands and waits
* the background, and returns immediately. Either way, this method returns quietly, no matter whether there was an * for workers to exit if "interrupt" is true, otherwise it returns immediately.
* exception associated with the future from {@link #start()} or not. *
* Either way, this method returns quietly, no matter whether there was an exception associated with the future
* from {@link #start()} or not.
* *
* @param interrupt whether to interrupt currently-running work * @param interrupt whether to interrupt currently-running work
*/ */