Returns whether docblocks should be generated
| public getGenerateDocblock ( ) : boolean | ||
| return | boolean | `true` if they will be generated and `false` if not |
public function testCodeGeneratorConfigSetters()
{
$config = new CodeGeneratorConfig();
$config->setGenerateDocblock(false);
$this->assertFalse($config->getGenerateDocblock());
$this->assertFalse($config->getGenerateEmptyDocblock());
$config->setGenerateEmptyDocblock(true);
$this->assertTrue($config->getGenerateDocblock());
$this->assertTrue($config->getGenerateEmptyDocblock());
$config->setGenerateEmptyDocblock(false);
$this->assertTrue($config->getGenerateDocblock());
$this->assertFalse($config->getGenerateEmptyDocblock());
$config->setGenerateReturnTypeHints(true);
$this->assertTrue($config->getGenerateReturnTypeHints());
$config->setGenerateScalarTypeHints(true);
$this->assertTrue($config->getGenerateScalarTypeHints());
$config->setUseStatementSorting(false);
$this->assertFalse($config->getUseStatementSorting());
$config->setConstantSorting('abc');
$this->assertEquals('abc', $config->getConstantSorting());
$config->setPropertySorting(new ComparableComparator());
$this->assertTrue($config->getPropertySorting() instanceof Comparator);
$cmp = function ($a, $b) {
return strcmp($a, $b);
};
$config->setMethodSorting($cmp);
$this->assertSame($cmp, $config->getMethodSorting());
$config->setSortingEnabled(false);
$this->assertFalse($config->isSortingEnabled());
}
/**
* @param DocblockInterface $model
* @return void
*/
protected function buildDocblock(DocblockInterface $model)
{
$this->ensureBlankLine();
if ($this->config->getGenerateDocblock()) {
$model->generateDocblock();
}
$docblock = $model->getDocblock();
if (!$docblock->isEmpty() || $this->config->getGenerateEmptyDocblock()) {
$this->writer->writeln($docblock->toString());
}
}
