Documentation for Factory

reactphp · jsor · Nov 10, 2017 · Nov 10, 2017 · Nov 10, 2017 · Nov 10, 2017
commit e360c730904e48581447d8fe11da9148c97c20e9
diff --git a/README.md b/README.md
@@ -94,6 +94,23 @@ $loop->run();
    purposes.
 3. The loop is run with a single `$loop->run()` call at the end of the program.
 
+## Factory
+
+The `Factory` class exists as a convenient way to pick the best available
+[loop implementation)(#loop-implementation).
+
+The `create(): LoopInterface` method can be used to create a new loop
+instance:
+
+```php
+$loop = React\EventLoop\Factory::create();
+```
+
+This method always returns an instance implementing `LoopInterface`,
+the actual loop implementation is an implementation detail.
+
+This method should usually only be called once at the beginning of the program.
+
 ## Loop implementations
 
 In addition to the interface there are the following implementations provided:

diff --git a/src/Factory.php b/src/Factory.php
@@ -2,8 +2,25 @@
 
 namespace React\EventLoop;
 
+/**
+ * The `Factory` class exists as a convenient way to pick the best available loop implementation.
+ */
 class Factory
 {
+    /**
+     * Creates a new loop instance
+     *
+     * ```php
+     * $loop = React\EventLoop\Factory::create();
+     * ```
+     *
+     * This method always returns an instance implementing `LoopInterface`,
+     * the actual loop implementation is an implementation detail.
+     *
+     * This method should usually only be called once at the beginning of the program.
+     *
+     * @return LoopInterface
+     */
     public static function create()
     {
         // @codeCoverageIgnoreStart