Code documentation is translated into English

Author: Finesse

CONTRIBUTING.md

@@ -0,0 +1,10 @@
+## Language
+
+We speak:
+
+* English
+* Русский
+
+You are welcome to submit issues in any of this languages.
+
+Comments in the code should be written in English.

composer.json

@@ -1,11 +1,12 @@
 {
     "name": "aiger-team/image-tools",
     "type": "library",
-    "description": "Light PHP tool for editing images using immutable objects style",
+    "description": "Light image editing tool with immutable objects style",
     "keywords": [
         "images",
         "pictures",
         "modify",
+        "edit",
         "resize",
         "crop",
         "rotate",
@@ -14,11 +15,11 @@
         "opacity",
         "transparent",
         "k-means",
-        "chaining",
         "watermark",
-        "stamp"
+        "stamp",
+        "immutable"
     ],
-    "homepage": "https://github.com/FinesseRus/ImageTools",
+    "homepage": "https://github.com/AigerTeam/ImageTools",
     "license": "MIT",
     "authors": [
         {

examples/resize/image.php

@@ -7,7 +7,7 @@
 
 use AigerTeam\ImageTools\ImageFactory;
 
-// Обработка изображения
+// Processing image
 $image = ( new ImageFactory() )
     ->openFile( 'example.jpg' )
     ->resize(
@@ -19,6 +19,6 @@
         $_GET[ 'alignVer' ]
     );
 
-// Вывод
+// Output image
 header( 'Content-type: ' . image_type_to_mime_type( $image->getRecommendedType() ) );
 $image->display();

src/Exceptions/FileException.php

@@ -5,19 +5,22 @@
 /**
  * Class FileException
  *
- * Исключение, выбрасываемое при ошибке, связанной с работой с файлом.
+ * Thrown in case of a file error.
  *
  * @author Finesse
  * @package AigerTeam\ImageTools\Exceptions
  */
 class FileException extends \Exception
 {
+    /**
+     * Path to the file in the filesystem on which error has occured
+     */
     protected $path;
 
     /**
      * {@inheritDoc}
      *
-     * @param string|null $path Путь в файловой системе, на котором произошла ошибка
+     * @param string|null $path Path to the file in the filesystem on which error has occured
      */
     public function __construct( $message, $path = null, $code = 0, \Exception $previous = null )
     {
@@ -26,10 +29,10 @@ public function __construct( $message, $path = null, $code = 0, \Exception $prev
     }
 
     /**
-     * @var string|null Возвращает путь в файловой системе, на котором произошла ошибка
+     * @return string|null Path to the file in the filesystem on which error has occured (if provided)
      */
     public function getPath()
     {
         return $this->path;
     }
-}
+}

src/Exceptions/ImageFileException.php

@@ -5,12 +5,9 @@
 /**
  * Class FileException
  *
- * Исключение, выбрасываемое, когда не удаётся получить изображение из файла.
+ * Thrown when image can't be retrieved from the file.
  *
  * @author Finesse
  * @package AigerTeam\ImageTools\Exceptions
  */
-class ImageFileException extends FileException
-{
-
-}
+class ImageFileException extends FileException {}