ENGCOM-3222: Add ReadFactory and WriteFactory to Magento's public API #17300

Author: Stanislav Idolov

lib/internal/Magento/Framework/Filesystem/Directory/ReadInterface.php

@@ -7,7 +7,7 @@
 
 /**
  * Interface \Magento\Framework\Filesystem\Directory\ReadInterface
- *
+ * @api
  */
 interface ReadInterface
 {

lib/internal/Magento/Framework/Filesystem/Directory/WriteInterface.php

@@ -7,7 +7,7 @@
 
 /**
  * Interface \Magento\Framework\Filesystem\Directory\WriteInterface
- *
+ * @api
  */
 interface WriteInterface extends ReadInterface
 {

lib/internal/Magento/Framework/Filesystem/File/ReadFactory.php

@@ -8,6 +8,10 @@
 use Magento\Framework\Filesystem\DriverInterface;
 use Magento\Framework\Filesystem\DriverPool;
 
+/**
+ * Opens a file for reading
+ * @api
+ */
 class ReadFactory
 {
     /**
@@ -28,7 +32,7 @@ public function __construct(DriverPool $driverPool)
     }
 
     /**
-     * Create a readable file
+     * Create a {@see ReaderInterface}
      *
      * @param string $path
      * @param DriverInterface|string $driver Driver or driver code

lib/internal/Magento/Framework/Filesystem/File/WriteFactory.php

@@ -8,6 +8,10 @@
 use Magento\Framework\Filesystem\DriverInterface;
 use Magento\Framework\Filesystem\DriverPool;
 
+/**
+ * Opens a file for reading and/or writing
+ * @api
+ */
 class WriteFactory extends ReadFactory
 {
     /**
@@ -29,12 +33,12 @@ public function __construct(DriverPool $driverPool)
     }
 
     /**
-     * Create a readable file.
+     * Create a {@see WriterInterface}
      *
      * @param string $path
      * @param DriverInterface|string $driver Driver or driver code
      * @param string $mode [optional]
-     * @return Write
+     * @return WriteInterface
      */
     public function create($path, $driver, $mode = 'r')
     {