minor PHP-CS-Fixer#5590 Docs: HeaderCommentFixer - document example h…

…ow to remove header comment (keradus)

This PR was squashed before being merged into the 2.18 branch.

Discussion
----------

Docs: HeaderCommentFixer - document example how to remove header comment

Commits
-------

def06db Docs: HeaderCommentFixer - document example how to remove header comment

doc/rules/comment/header_comment.rst

@@ -110,3 +110,24 @@ With configuration: ``['header' => 'Made with love.', 'comment_type' => 'comment
     namespace A\B;
 
     echo 1;
+
+Example #4
+~~~~~~~~~~
+
+With configuration: ``['header' => '']``.
+
+.. code-block:: diff
+
+   --- Original
+   +++ New
+   @@ -1,10 +1,6 @@
+    <?php
+    declare(strict_types=1);
+
+   -/*
+   - * Comment is not wanted here.
+   - */
+   -
+    namespace A\B;
+
+    echo 1;

src/Fixer/Comment/HeaderCommentFixer.php

@@ -102,6 +102,22 @@ public function getDefinition()
                         'location' => 'after_declare_strict',
                     ]
                 ),
+                new CodeSample(
+                    '<?php
+declare(strict_types=1);
+
+/*
+ * Comment is not wanted here.
+ */
+
+namespace A\B;
+
+echo 1;
+',
+                    [
+                        'header' => '',
+                    ]
+                ),
             ]
         );
     }