Skip to content

Commit dabf301

Browse files
committed
Fixed formatting of comment (ref #2864)
1 parent 51d4409 commit dabf301

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

src/Config.php

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@
1414

1515
use PHP_CodeSniffer\Exceptions\DeepExitException;
1616
use PHP_CodeSniffer\Exceptions\RuntimeException;
17+
1718
/**
18-
* Class Config
19+
* Stores the configuration used to run PHPCS and PHPCBF.
1920
*
2021
* @property string[] $files The files and directories to check.
2122
* @property string[] $standards The standards being used for checking.
@@ -56,15 +57,17 @@
5657
* @property bool $stdin Read content from STDIN instead of supplied files.
5758
* @property string $stdinContent Content passed directly to PHPCS on STDIN.
5859
* @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+
*
6871
* @property string[] $unknown Any arguments gathered on the command line that are unknown to us.
6972
* E.g., using `phpcs -c` will give array('c');
7073
*/
@@ -93,7 +96,7 @@ class Config
9396
* can be used to validate the values. For example, to set the verbosity level to
9497
* level 2, use $this->verbosity = 2; instead of accessing this property directly.
9598
*
96-
* All of those are described in class annotation as @property
99+
* Each of these settings is described in the class comment property list.
97100
*
98101
* @var array<string, mixed>
99102
*/

0 commit comments

Comments
 (0)