Update doc blocks for static tests

Author: adrian-martinez-interactiv4

lib/internal/Magento/Framework/App/DeploymentConfig/Writer/PhpFormatter.php

@@ -21,20 +21,20 @@ class PhpFormatter implements FormatterInterface
     public function format($data, array $comments = [])
     {
         if (!empty($comments) && is_array($data)) {
-            return "<?php\nreturn array (\n" . $this->formatData($data, $comments, '  ') . "\n);\n";
+            return "<?php\nreturn array (\n" . $this->formatData($data, $comments) . "\n);\n";
         }
         return "<?php\nreturn " . var_export($data, true) . ";\n";
     }
 
     /**
      * Format supplied data
      *
-     * @param $data
-     * @param $comments
+     * @param string[] $data
+     * @param string[] $comments
      * @param string $prefix
      * @return string
      */
-    protected function formatData($data, $comments, $prefix = '')
+    private function formatData($data, $comments = [], $prefix = '  ')
     {
         $elements = [];
 

lib/internal/Magento/Framework/App/Test/Unit/DeploymentConfig/Writer/PhpFormatterTest.php

@@ -3,7 +3,6 @@
  * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 namespace Magento\Framework\App\Test\Unit\DeploymentConfig\Writer;
 
 use Magento\Framework\App\DeploymentConfig\Writer\PhpFormatter;
@@ -12,8 +11,8 @@ class PhpFormatterTest extends \PHPUnit_Framework_TestCase
 {
     /**
      * @dataProvider formatWithCommentDataProvider
-     * @param string|array $data
-     * @param array $comments
+     * @param string[] $data
+     * @param string[] $comments
      * @param string $expectedResult
      */
     public function testFormat($data, $comments, $expectedResult)
@@ -22,6 +21,9 @@ public function testFormat($data, $comments, $expectedResult)
         $this->assertEquals($expectedResult, $formatter->format($data, $comments));
     }
 
+    /**
+     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
+     */
     public function formatWithCommentDataProvider()
     {
         $array = [
@@ -45,9 +47,9 @@ public function formatWithCommentDataProvider()
         ];
         $comments1 = ['ns2' => 'comment for namespace 2'];
         $comments2 = [
-            'ns1' => 'comment for namespace 1',
-            'ns2' => "comment for namespace 2.\nNext comment for namespace 2",
-            'ns3' => 'comment for namespace 3',
+            'ns1' => 'comment for\' namespace 1',
+            'ns2' => "comment for namespace 2.\nNext comment for' namespace 2",
+            'ns3' => 'comment for" namespace 3',
             'ns4' => 'comment for namespace 4',
             'ns5' => 'comment for unexisted namespace 5',
         ];
@@ -88,7 +90,7 @@ public function formatWithCommentDataProvider()
 return array (
   /**
    * For the section: ns1
-   * comment for namespace 1
+   * comment for' namespace 1
    */
   'ns1' => 
   array (
@@ -106,7 +108,7 @@ public function formatWithCommentDataProvider()
   /**
    * For the section: ns2
    * comment for namespace 2.
-   * Next comment for namespace 2
+   * Next comment for' namespace 2
    */
   'ns2' => 
   array (
@@ -117,7 +119,7 @@ public function formatWithCommentDataProvider()
   ),
   /**
    * For the section: ns3
-   * comment for namespace 3
+   * comment for" namespace 3
    */
   'ns3' => 'just text',
   /**