1
0
mirror of https://github.com/danog/amp.git synced 2024-11-30 04:29:08 +01:00

Improve enable() doc and mention it also in the class level phpdoc block

This commit is contained in:
Niklas Keller 2017-02-09 09:50:23 +01:00
parent 5249aa65a8
commit c2b598ee9c
2 changed files with 8 additions and 7 deletions

View File

@ -259,9 +259,8 @@ final class Loop
/**
* Enable a watcher.
*
* Watchers (enabling or new watchers) MUST immediately be marked as enabled, but only be activated (i.e. callbacks
* can be called) right before the next tick. Callbacks of watchers MUST not be called in the tick they were
* enabled.
* Watchers MUST immediately be marked as enabled, but only be activated (i.e. callbacks can be called) right before
* the next tick. Callbacks of watchers MUST NOT be called in the tick they were enabled.
*
* @param string $watcherId The watcher identifier.
*

View File

@ -5,7 +5,10 @@ namespace AsyncInterop\Loop;
/**
* Event loop driver which implements all basic operations to allow interoperability.
*
* Registered callbacks MUST NOT be called from a file with strict types enabled (`declare(strict_types=1)`).
* Watchers (enabled or new watchers) MUST immediately be marked as enabled, but only be activated (i.e. callbacks can
* be called) right before the next tick. Callbacks of watchers MUST NOT be called in the tick they were enabled.
*
* All registered callbacks MUST NOT be called from a file with strict types enabled (`declare(strict_types=1)`).
*/
abstract class Driver
{
@ -143,9 +146,8 @@ abstract class Driver
/**
* Enable a watcher.
*
* Watchers (enabling or new watchers) MUST immediately be marked as enabled, but only be activated (i.e. callbacks
* can be called) right before the next tick. Callbacks of watchers MUST not be called in the tick they were
* enabled.
* Watchers MUST immediately be marked as enabled, but only be activated (i.e. callbacks can be called) right before
* the next tick. Callbacks of watchers MUST NOT be called in the tick they were enabled.
*
* @param string $watcherId The watcher identifier.
*