update doc

LICENSE

@@ -12,7 +12,7 @@ modification, are permitted provided that the following conditions are met:
  - Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.
- - Neither the name of the Chris Boulton nor the names of its contributors
+ - Neither the name of the Mario Brandt nor the names of its contributors
    may be used to endorse or promote products derived from this software
    without specific prior written permission.
 

lib/jblond/Diff.php

@@ -21,14 +21,14 @@
  *
  * PHP version 7.2 or greater
  *
- * @package       jblond
- * @author        Chris Boulton <[email protected]>
- * @author Mario Brandt <[email protected]>
- * @author        Ferry Cools <[email protected]>
- * @copyright (c) 2009 Chris Boulton
- * @license       New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version       2.0.0
- * @link          https://github.com/JBlond/php-diff
+ * @package     jblond
+ * @author      Chris Boulton <[email protected]>
+ * @author      Mario Brandt <[email protected]>
+ * @author      Ferry Cools <[email protected]>
+ * @copyright   (c) 2020 Mario Brandt
+ * @license     New BSD License http://www.opensource.org/licenses/bsd-license.php
+ * @version     2.1.0
+ * @link        https://github.com/JBlond/php-diff
  */
 class Diff
 {
@@ -50,8 +50,9 @@ class Diff
     private $groupedCodes;
 
     /**
-     * @var array   Associative array containing the default options available for the diff class and their default
-     *              value.
+     * @var array<string> Associative array containing the default options available
+     *                    for the diff class and their default value.
+     *
      *              - context           The amount of lines to include around blocks that differ.
      *              - trimEqual         Strip blocks of equal lines from the start and end of the text.
      *              - ignoreWhitespace  When true, tabs and spaces are ignored while comparing.
@@ -111,8 +112,8 @@ public function __construct($version1, $version2, array $options = [])
      *
      * @param mixed $var Variable to get type from.
      *
-     * @return int  Number indicating the type of the variable. 0 for array type and 1 for string type.
-     * @throws InvalidArgumentException    When the type isn't 'array' or 'string'.
+     * @return int Number indicating the type of the variable. 0 for array type and 1 for string type.
+     * @throws InvalidArgumentException When the type isn't 'array' or 'string'.
      *
      */
     public function getArgumentType($var): int

lib/jblond/Diff/DiffUtils.php

@@ -7,11 +7,11 @@
  *
  * PHP version 7.2 or greater
  *
- * @package jblond\Diff
- * @author Mario Brandt <[email protected]>
- * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version 2.0.0
- * @link https://github.com/JBlond/php-diff
+ * @package     jblond\Diff
+ * @author      Mario Brandt <[email protected]>
+ * @license     New BSD License http://www.opensource.org/licenses/bsd-license.php
+ * @version     2.1.0
+ * @link        https://github.com/JBlond/php-diff
  */
 class DiffUtils
 {

lib/jblond/Diff/Renderer/Html/HtmlArray.php

@@ -11,20 +11,21 @@
  *
  * PHP version 7.2 or greater
  *
- * @package       jblond\Diff\Renderer\Html
- * @author        Chris Boulton <[email protected]>
- * @author Mario Brandt <[email protected]>
- * @author        Ferry Cools <[email protected]>
- * @copyright (c) 2009 Chris Boulton
- * @license       New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version       2.0.0
- * @link          https://github.com/JBlond/php-diff
+ * @package     jblond\Diff\Renderer\Html
+ * @author      Chris Boulton <[email protected]>
+ * @author      Mario Brandt <[email protected]>
+ * @author      Ferry Cools <[email protected]>
+ * @copyright   (c) 2020 Mario Brandt
+ * @license     New BSD License http://www.opensource.org/licenses/bsd-license.php
+ * @version     2.1.0
+ * @link        https://github.com/JBlond/php-diff
  */
 class HtmlArray extends RendererAbstract
 {
     /**
-     * @var array   Associative array containing the default options available for this renderer and their default
-     *              value.
+     * @var array<string> Associative array containing the default options available
+     *                    for this renderer and their default value.
+     *
      *              - tabSize   The amount of spaces to replace a tab character with.
      *              - title_a   Title of the "old" version of text.
      *              - title_b   Title of the "new" version of text.
@@ -46,7 +47,7 @@ class HtmlArray extends RendererAbstract
      *
      * This method is called by the renderers which extends this class.
      *
-     * @param array  $changes      Contains the op-codes about the differences between "old and "new".
+     * @param array $changes Contains the op-codes about the differences between "old and "new".
      * @param object|Inline|SideBySide|Unified $htmlRenderer Renderer which extends this class.
      *
      * @return string HTML representation of the differences.

lib/jblond/Diff/Renderer/Html/Inline.php

@@ -9,14 +9,14 @@
  *
  * PHP version 7.2 or greater
  *
- * @package       jblond\Diff\Renderer\Html
- * @author        Chris Boulton <[email protected]>
- * @author Mario Brandt <[email protected]>
- * @author        Ferry Cools <[email protected]>
- * @copyright (c) 2009 Chris Boulton
- * @license       New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version       2.0.0
- * @link          https://github.com/JBlond/php-diff
+ * @package     jblond\Diff\Renderer\Html
+ * @author      Chris Boulton <[email protected]>
+ * @author      Mario Brandt <[email protected]>
+ * @author      Ferry Cools <[email protected]>
+ * @copyright   (c) 2020 Mario Brandt
+ * @license     New BSD License http://www.opensource.org/licenses/bsd-license.php
+ * @version     2.1.0
+ * @link        https://github.com/JBlond/php-diff
  */
 class Inline extends HtmlArray
 {

lib/jblond/Diff/Renderer/Html/SideBySide.php

@@ -9,14 +9,14 @@
  *
  * PHP version 7.2 or greater
  *
- * @package       jblond\Diff\Renderer\Html
- * @author        Chris Boulton <[email protected]>
- * @author Mario Brandt <[email protected]>
- * @author        Ferry Cools <[email protected]>
- * @copyright (c) 2009 Chris Boulton
- * @license       New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version       2.0.0
- * @link          https://github.com/JBlond/php-diff
+ * @package     jblond\Diff\Renderer\Html
+ * @author      Chris Boulton <[email protected]>
+ * @author      Mario Brandt <[email protected]>
+ * @author      Ferry Cools <[email protected]>
+ * @copyright   (c) 2009 Chris Boulton
+ * @license     New BSD License http://www.opensource.org/licenses/bsd-license.php
+ * @version     2.1.0
+ * @link        https://github.com/JBlond/php-diff
  */
 class SideBySide extends HtmlArray
 {

lib/jblond/Diff/Renderer/Html/Unified.php

@@ -10,11 +10,11 @@
  * PHP version 7.2 or greater
  *
  * @package       jblond\Diff\Renderer\Html
- * @author Mario Brandt <[email protected]>
+ * @author        Mario Brandt <[email protected]>
  * @author        Ferry Cools <[email protected]>
- * @copyright (c) 2009 Chris Boulton
+ * @copyright     (c) 2020 Mario Brandt
  * @license       New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version       2.0.0
+ * @version       2.1.0
  * @link          https://github.com/JBlond/php-diff
  */
 class Unified extends HtmlArray

lib/jblond/Diff/Renderer/RendererAbstract.php

@@ -11,14 +11,14 @@
  *
  * PHP version 7.2 or greater
  *
- * @package       jblond\Diff\Renderer
- * @author        Chris Boulton <[email protected]>
- * @author Mario Brandt <[email protected]>
- * @author        Ferry Cools <[email protected]>
- * @copyright (c) 2009 Chris Boulton
- * @license       New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version       2.0.0
- * @link          https://github.com/JBlond/php-diff
+ * @package     jblond\Diff\Renderer
+ * @author      Chris Boulton <[email protected]>
+ * @author      Mario Brandt <[email protected]>
+ * @author      Ferry Cools <[email protected]>
+ * @copyright   (c) 2020 Mario Brandt
+ * @license     New BSD License http://www.opensource.org/licenses/bsd-license.php
+ * @version     2.1.0
+ * @link        https://github.com/JBlond/php-diff
  */
 abstract class RendererAbstract
 {
@@ -29,15 +29,15 @@ abstract class RendererAbstract
     public $diff;
 
     /**
-     * @var array Array of the default options that apply to this renderer.
+     * @var array<string> Array of the default options that apply to this renderer.
      */
     protected $defaultOptions = [
         'title1' => 'Version1',
         'title2' => 'Version2',
     ];
 
     /**
-     * @var array Array containing the user applied and merged default options for the renderer.
+     * @var array<string> Array containing the user applied and merged default options for the renderer.
      */
     protected $options = [];
 
@@ -57,7 +57,7 @@ public function __construct(array $options = [])
      * Options are merged with the default to ensure that there aren't any missing
      * options.
      *
-     * @param array $options Array of options to set.
+     * @param array<string> $options Array of options to set.
      */
     public function setOptions(array $options)
     {

lib/jblond/Diff/Renderer/Text/Context.php

@@ -11,14 +11,14 @@
  *
  * PHP version 7.2 or greater
  *
- * @package       jblond\Diff\Renderer\Text
- * @author        Chris Boulton <[email protected]>
- * @author Mario Brandt <[email protected]>
- * @author        Ferry Cools <[email protected]>
- * @copyright (c) 2009 Chris Boulton
- * @license       New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version       2.0.0
- * @link          https://github.com/JBlond/php-diff
+ * @package     jblond\Diff\Renderer\Text
+ * @author      Chris Boulton <[email protected]>
+ * @author      Mario Brandt <[email protected]>
+ * @author      Ferry Cools <[email protected]>
+ * @copyright   (c) 2009 Chris Boulton
+ * @license     New BSD License http://www.opensource.org/licenses/bsd-license.php
+ * @version     2.1.0
+ * @link        https://github.com/JBlond/php-diff
  */
 class Context extends RendererAbstract
 {

lib/jblond/Diff/Renderer/Text/Unified.php

@@ -11,13 +11,13 @@
  *
  * PHP version 7.2 or greater
  *
- * @package  jblond\Diff\Renderer\Text
- * @author Chris Boulton <[email protected]>
- * @author Mario Brandt <[email protected]>
- * @copyright (c) 2009 Chris Boulton
- * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version 2.0.0
- * @link https://github.com/JBlond/php-diff
+ * @package     jblond\Diff\Renderer\Text
+ * @author      Chris Boulton <[email protected]>
+ * @author      Mario Brandt <[email protected]>
+ * @copyright   (c) 2020 Mario Brandt
+ * @license     New BSD License http://www.opensource.org/licenses/bsd-license.php
+ * @version     2.1.0
+ * @link        https://github.com/JBlond/php-diff
  */
 
 /**

lib/jblond/Diff/Renderer/Text/UnifiedCli.php

@@ -12,11 +12,11 @@
  *
  * PHP version 7.2 or greater
  *
- * @package  jblond\Diff\Renderer\Text
- * @author Mario Brandt <[email protected]>
- * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version 2.0.0
- * @link https://github.com/JBlond/php-diff
+ * @package     jblond\Diff\Renderer\Text
+ * @author      Mario Brandt <[email protected]>
+ * @license     New BSD License http://www.opensource.org/licenses/bsd-license.php
+ * @version     2.1.0
+ * @link        https://github.com/JBlond/php-diff
  */
 
 class UnifiedCli extends RendererAbstract
@@ -34,7 +34,7 @@ class UnifiedCli extends RendererAbstract
 
     /**
      * UnifiedCli constructor.
-     * @param array $options
+     * @param array<string> $options
      */
     public function __construct(array $options = [])
     {
@@ -62,11 +62,11 @@ public function render(): string
 
 
     /**
-     * @param $string
+     * @param string $string
      * @param string $color
      * @return string
      */
-    private function colorizeString($string, $color = ''): string
+    private function colorizeString(string $string, string $color = ''): string
     {
         if (isset($this->options['cliColor']) && $this->options['cliColor'] == 'simple') {
             return $this->colors->getColoredString($string, $color);

lib/jblond/Diff/SequenceMatcher.php

@@ -11,14 +11,14 @@
  *
  * PHP version 7.2 or greater
  *
- * @package jblond\Diff
- * @author Chris Boulton <[email protected]>
- * @author Mario Brandt <[email protected]>
- * @author Ferry Cools <[email protected]>
- * @copyright (c) 2009 Chris Boulton
- * @license New BSD License http://www.opensource.org/licenses/bsd-license.php
- * @version 2.0.0
- * @link https://github.com/JBlond/php-diff
+ * @package     jblond\Diff
+ * @author      Chris Boulton <[email protected]>
+ * @author      Mario Brandt <[email protected]>
+ * @author      Ferry Cools <[email protected]>
+ * @copyright   (c) 2020 Mario Brandt
+ * @license     New BSD License http://www.opensource.org/licenses/bsd-license.php
+ * @version     2.1.0
+ * @link        https://github.com/JBlond/php-diff
  */
 class SequenceMatcher
 {
@@ -79,9 +79,9 @@ class SequenceMatcher
      * sequence matcher and it will perform a basic cleanup & calculate junk
      * elements.
      *
-     * @param string|array $old A string or array containing the lines to compare against.
-     * @param string|array $new A string or array containing the lines to compare.
-     * @param array $options
+     * @param string|array      $old A string or array containing the lines to compare against.
+     * @param string|array      $new A string or array containing the lines to compare.
+     * @param array             $options
      * @param string|array|null $junkCallback Either an array or string that references a callback function
      * (if there is one) to determine 'junk' characters.
      */
@@ -212,7 +212,7 @@ private function chainB()
      * for the list of junk characters.
      *
      * @param string $bString
-     * @return bool $b True if the character is considered junk. False if not.
+     * @return bool True if the character is considered junk. False if not.
      */
     private function isBJunk(string $bString): bool
     {