Fixed formatting of comment (ref #2864)

squizlabs · Feb 17, 2020 · dabf301 · dabf301
1 parent 51d4409
commit dabf301
Showing 1 changed file with 14 additions and 11 deletions.
diff --git a/src/Config.php b/src/Config.php
@@ -14,8 +14,9 @@
 
 use PHP_CodeSniffer\Exceptions\DeepExitException;
 use PHP_CodeSniffer\Exceptions\RuntimeException;
+
 /**
- * Class Config
+ * Stores the configuration used to run PHPCS and PHPCBF.
  *
  * @property string[] $files           The files and directories to check.
  * @property string[] $standards       The standards being used for checking.
@@ -56,15 +57,17 @@
  * @property bool     $stdin           Read content from STDIN instead of supplied files.
  * @property string   $stdinContent    Content passed directly to PHPCS on STDIN.
  * @property string   $stdinPath       The path to use for content passed on STDIN.
- * @property array<string, string>   $extensions File extensions that should be checked, and what tokenizer to use.
- *                                               E.g., array('inc' => 'PHP');
- * @property array<string, string|null> $reports The reports to use for printing output after the run.
- *                                               The format of the array is:
- *                                                   array(
- *                                                    'reportName1' => 'outputFile',
- *                                                    'reportName2' => null,
- *                                                   );
- *                                               If the array value is NULL, the report will be written to the screen.
+ *
+ * @property array<string, string>      $extensions File extensions that should be checked, and what tokenizer to use.
+ *                                                  E.g., array('inc' => 'PHP');
+ * @property array<string, string|null> $reports    The reports to use for printing output after the run.
+ *                                                  The format of the array is:
+ *                                                      array(
+ *                                                          'reportName1' => 'outputFile',
+ *                                                          'reportName2' => null,
+ *                                                      );
+ *                                                  If the array value is NULL, the report will be written to the screen.
+ *
  * @property string[] $unknown Any arguments gathered on the command line that are unknown to us.
  *                             E.g., using `phpcs -c` will give array('c');
  */
@@ -93,7 +96,7 @@ class Config
      * can be used to validate the values. For example, to set the verbosity level to
      * level 2, use $this->verbosity = 2; instead of accessing this property directly.
      *
-     * All of those are described in class annotation as @property
+     * Each of these settings is described in the class comment property list.
      *
      * @var array<string, mixed>
      */