|
14 | 14 |
|
15 | 15 | use PHP_CodeSniffer\Exceptions\DeepExitException; |
16 | 16 | use PHP_CodeSniffer\Exceptions\RuntimeException; |
| 17 | + |
17 | 18 | /** |
18 | | - * Class Config |
| 19 | + * Stores the configuration used to run PHPCS and PHPCBF. |
19 | 20 | * |
20 | 21 | * @property string[] $files The files and directories to check. |
21 | 22 | * @property string[] $standards The standards being used for checking. |
|
56 | 57 | * @property bool $stdin Read content from STDIN instead of supplied files. |
57 | 58 | * @property string $stdinContent Content passed directly to PHPCS on STDIN. |
58 | 59 | * @property string $stdinPath The path to use for content passed on STDIN. |
59 | | - * @property array<string, string> $extensions File extensions that should be checked, and what tokenizer to use. |
60 | | - * E.g., array('inc' => 'PHP'); |
61 | | - * @property array<string, string|null> $reports The reports to use for printing output after the run. |
62 | | - * The format of the array is: |
63 | | - * array( |
64 | | - * 'reportName1' => 'outputFile', |
65 | | - * 'reportName2' => null, |
66 | | - * ); |
67 | | - * If the array value is NULL, the report will be written to the screen. |
| 60 | + * |
| 61 | + * @property array<string, string> $extensions File extensions that should be checked, and what tokenizer to use. |
| 62 | + * E.g., array('inc' => 'PHP'); |
| 63 | + * @property array<string, string|null> $reports The reports to use for printing output after the run. |
| 64 | + * The format of the array is: |
| 65 | + * array( |
| 66 | + * 'reportName1' => 'outputFile', |
| 67 | + * 'reportName2' => null, |
| 68 | + * ); |
| 69 | + * If the array value is NULL, the report will be written to the screen. |
| 70 | + * |
68 | 71 | * @property string[] $unknown Any arguments gathered on the command line that are unknown to us. |
69 | 72 | * E.g., using `phpcs -c` will give array('c'); |
70 | 73 | */ |
@@ -93,7 +96,7 @@ class Config |
93 | 96 | * can be used to validate the values. For example, to set the verbosity level to |
94 | 97 | * level 2, use $this->verbosity = 2; instead of accessing this property directly. |
95 | 98 | * |
96 | | - * All of those are described in class annotation as @property |
| 99 | + * Each of these settings is described in the class comment property list. |
97 | 100 | * |
98 | 101 | * @var array<string, mixed> |
99 | 102 | */ |
|
0 commit comments