Named parts *Part; Fixed comments and cs

Author: gossi

.php_cs

@@ -18,7 +18,6 @@ return Config::create()
 	->fixers([
 		'encoding',
 		'short_tag',
-		//'braces',
 		'eof_ending',
 		'function_call_space',
 		'function_declaration',

src/config/CodeFileGeneratorConfig.php

@@ -4,14 +4,25 @@
 use gossi\docblock\Docblock;
 use Symfony\Component\OptionsResolver\Options;
 
+/**
+ * Configuration for code file generation
+ *
+ * @author Thomas Gossmann
+ */
 class CodeFileGeneratorConfig extends CodeGeneratorConfig {
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function getOptionalOptions() {
 		return array_merge([
 				'headerComment', 'headerDocblock', 'blankLineAtEnd', 'declareStrictTypes'
 			], parent::getOptionalOptions());
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function getDefaultOptions() {
 		return array_merge(
 			parent::getDefaultOptions(), [
@@ -28,6 +39,9 @@ protected function getDefaultOptions() {
 			]);
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function getAllowedOptionTypes() {
 		return array_merge([
 				'headerComment' => 'string',
@@ -39,7 +53,7 @@ protected function getAllowedOptionTypes() {
 
 	/**
 	 * Returns the file header comment
-	 * 
+	 *
 	 * @return string the header comment
 	 */
 	public function getHeaderComment() {
@@ -48,7 +62,7 @@ public function getHeaderComment() {
 
 	/**
 	 * Sets the file header comment
-	 * 
+	 *
 	 * @param string $comment the header comment
 	 * @return $this
 	 */
@@ -59,7 +73,7 @@ public function setHeaderComment($comment) {
 
 	/**
 	 * Returns the file header docblock
-	 * 
+	 *
 	 * @return Docblock the docblock
 	 */
 	public function getHeaderDocblock() {
@@ -68,7 +82,7 @@ public function getHeaderDocblock() {
 
 	/**
 	 * Sets the file header docblock
-	 * 
+	 *
 	 * @param Docblock $docblock the docblock
 	 * @return $this
 	 */
@@ -79,7 +93,7 @@ public function setHeaderDocblock(Docblock $docblock) {
 
 	/**
 	 * Returns whether a blank line should be generated at the end of the file
-	 * 
+	 *
 	 * @return bool `true` if it will be generated and `false` if not
 	 */
 	public function getBlankLineAtEnd() {
@@ -88,7 +102,7 @@ public function getBlankLineAtEnd() {
 
 	/**
 	 * Sets whether a blank line should be generated at the end of the file
-	 * 
+	 *
 	 * @param bool $show `true` if it will be generated and `false` if not
 	 * @return $this
 	 */
@@ -98,19 +112,19 @@ public function setBlankLineAtEnd($show) {
 	}
 
 	/**
-	 * Returns whether a `declare(strict_types=1);` statement should be printed 
+	 * Returns whether a `declare(strict_types=1);` statement should be printed
 	 * below the header comments (PHP 7)
-	 * 
+	 *
 	 * @return bool `true` if it will be printed and `false` if not
 	 */
 	public function getDeclareStrictTypes() {
 		return $this->options['declareStrictTypes'];
 	}
 
 	/**
-	 * Sets whether a `declare(strict_types=1);` statement should be printed 
+	 * Sets whether a `declare(strict_types=1);` statement should be printed
 	 * below the header comments (PHP 7)
-	 * 
+	 *
 	 * @param bool $strict `true` if it will be printed and `false` if not
 	 * @return $this
 	 */

src/config/CodeGeneratorConfig.php

@@ -5,17 +5,17 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
- * Configuration for code generator
- * 
- * @author gossi
+ * Configuration for code generation
+ *
+ * @author Thomas Gossmann
  */
 class CodeGeneratorConfig {
 
 	protected $options;
 
 	/**
 	 * Creates a new configuration for code generator
-	 * 
+	 *
 	 * @see https://php-code-generator.readthedocs.org/en/latest/generator.html
 	 * @param array $options
 	 */
@@ -29,6 +29,11 @@ public function __construct(array $options = []) {
 		$this->options = $resolver->resolve($options);
 	}
 
+	/**
+	 * Return optional config options
+	 *
+	 * @return array
+	 */
 	protected function getOptionalOptions() {
 		return [
 			'generateDocblock',
@@ -38,6 +43,11 @@ protected function getOptionalOptions() {
 		];
 	}
 
+	/**
+	 * Return default config options
+	 *
+	 * @return array
+	 */
 	protected function getDefaultOptions() {
 		return [
 			'generateDocblock' => true,
@@ -49,6 +59,11 @@ protected function getDefaultOptions() {
 		];
 	}
 
+	/**
+	 * Return allowed option types
+	 *
+	 * @return array
+	 */
 	protected function getAllowedOptionTypes() {
 		return [
 			'generateDocblock' => 'bool',
@@ -60,7 +75,7 @@ protected function getAllowedOptionTypes() {
 
 	/**
 	 * Returns whether docblocks should be generated
-	 * 
+	 *
 	 * @return bool `true` if they will be generated and `false` if not
 	 */
 	public function getGenerateDocblock() {
@@ -83,7 +98,7 @@ public function setGenerateDocblock($generate) {
 
 	/**
 	 * Returns whether empty docblocks are generated
-	 * 
+	 *
 	 * @return bool `true` if they will be generated and `false` if not
 	 */
 	public function getGenerateEmptyDocblock() {
@@ -106,7 +121,7 @@ public function setGenerateEmptyDocblock($generate) {
 
 	/**
 	 * Returns whether scalar type hints will be generated for method parameters (PHP 7)
-	 * 
+	 *
 	 * @return bool `true` if they will be generated and `false` if not
 	 */
 	public function getGenerateScalarTypeHints() {
@@ -126,7 +141,7 @@ public function setGenerateScalarTypeHints($generate) {
 
 	/**
 	 * Returns whether return type hints will be generated for method parameters (PHP 7)
-	 * 
+	 *
 	 * @return bool `true` if they will be generated and `false` if not
 	 */
 	public function getGenerateReturnTypeHints() {

src/generator/CodeFileGenerator.php

@@ -7,17 +7,17 @@
 
 /**
  * Code file generator.
- * 
+ *
  * Generates code for a model and puts it into a file with `<?php` statements. Can also
- * generate header comments. 
- * 
- * @author gossi
+ * generate header comments.
+ *
+ * @author Thomas Gossmann
  */
 class CodeFileGenerator extends CodeGenerator {
 
 	/**
 	 * Creates a new CodeFileGenerator
-	 * 
+	 *
 	 * @see https://php-code-generator.readthedocs.org/en/latest/generator.html
 	 * @param CodeFileGeneratorConfig|array $config
 	 */
@@ -35,7 +35,7 @@ public function __construct($config = null) {
 
 	/**
 	 * {@inheritDoc}
-	 * 
+	 *
 	 * @return CodeFileGeneratorConfig
 	 */
 	public function getConfig() {

src/generator/CodeGenerator.php

@@ -5,12 +5,19 @@
 use gossi\codegen\model\GenerateableInterface;
 use gossi\codegen\visitor\GeneratorVisitor;
 
+/**
+ * Code generator
+ *
+ * Generates code for any generateable model
+ *
+ * @author Thomas Gossmann
+ */
 class CodeGenerator {
 
 	protected $config;
 
 	/**
-	 * @var DefaultGeneratorStrategy
+	 * @var GeneratorStrategy
 	 */
 	protected $strategy;
 
@@ -37,7 +44,7 @@ protected function init() {
 
 	/**
 	 * Returns the used configuration
-	 * 
+	 *
 	 * @return CodeGeneratorConfig
 	 */
 	public function getConfig() {
@@ -46,7 +53,7 @@ public function getConfig() {
 
 	/**
 	 * Returns the used generator strategy
-	 * 
+	 *
 	 * @return DefaultGeneratorStrategy
 	 */
 	public function getGeneratorStrategy() {
@@ -55,7 +62,7 @@ public function getGeneratorStrategy() {
 
 	/**
 	 * Generates code from a given model
-	 * 
+	 *
 	 * @param GenerateableInterface $model
 	 * @return string the generated code
 	 */

src/generator/GeneratorStrategy.php

@@ -56,6 +56,10 @@ public function setUseStatementSortFunc(\Closure $func = null) {
 		$this->navigator->setUseStatementSortFunc($func);
 	}
 
+	/**
+	 * @param GenerateableInterface $class
+	 * @return string
+	 */
 	public function generate(GenerateableInterface $class) {
 		$this->visitor->reset();
 		$this->navigator->accept($this->visitor, $class);