$defaultPackageName
$defaultPackageName : string
Class responsible for parsing the given file or files to the intermediate structure file.
This class can be used to parse one or more files to the intermediate file format for further processing.
__construct(\phpDocumentor\Reflection\ProjectFactory $projectFactory, \Symfony\Component\Stopwatch\Stopwatch $stopwatch, \Psr\Log\LoggerInterface $logger) : mixed
Initializes the parser.
This constructor checks the user's PHP ini settings to detect which encoding is used by default. This encoding is used as a default value for phpDocumentor to convert the source files that it receives.
If no encoding is specified than 'utf-8' is assumed by default.
\phpDocumentor\Reflection\ProjectFactory | $projectFactory | |
\Symfony\Component\Stopwatch\Stopwatch | $stopwatch | |
\Psr\Log\LoggerInterface | $logger |
setEncoding(string $encoding) : void
Sets the encoding of the files.
With this option it is possible to tell the parser to use a specific encoding to interpret the provided files.
By default this is set to UTF-8, in which case no action is taken. Any other encoding will result in the output
being converted to UTF-8 using iconv
.
Please note that it is recommended to provide files in UTF-8 format; this will ensure a faster performance since no transformation is required.
string | $encoding |