added doc comments to the different classes

Author: schmittjoh

src/CG/Core/AbstractClassGenerator.php

@@ -4,6 +4,11 @@
 
 use CG\Generator\PhpClass;
 
+/**
+ * Abstract base class for all class generators.
+ *
+ * @author Johannes M. Schmitt <[email protected]>
+ */
 abstract class AbstractClassGenerator implements ClassGeneratorInterface
 {
     private $namingStrategy;

src/CG/Core/ClassGeneratorInterface.php

@@ -2,7 +2,19 @@
 
 namespace CG\Core;
 
+use CG\Generator\PhpClass;
+
+/**
+ * Interface for class generators.
+ *
+ * @author Johannes M. Schmitt <[email protected]>
+ */
 interface ClassGeneratorInterface
 {
+    /**
+     * Generates the PHP class.
+     *
+     * @return string
+     */
     function generateClass();
 }

src/CG/Generator/AbstractPhpMember.php

@@ -2,6 +2,11 @@
 
 namespace CG\Generator;
 
+/**
+ * Abstract PHP member class.
+ *
+ * @author Johannes M. Schmitt <[email protected]>
+ */
 abstract class AbstractPhpMember
 {
     const VISIBILITY_PRIVATE = 'private';

src/CG/Generator/DefaultNavigator.php

@@ -2,22 +2,48 @@
 
 namespace CG\Generator;
 
+/**
+ * The default navigator.
+ *
+ * This class is responsible for the default traversal algorithm of the different
+ * code elements.
+ *
+ * Unlike other visitor pattern implementations, this allows to separate the
+ * traversal logic from the objects that are traversed.
+ *
+ * @author Johannes M. Schmitt <[email protected]>
+ */
 class DefaultNavigator
 {
     private $constantSortFunc;
     private $propertySortFunc;
     private $methodSortFunc;
 
+    /**
+     * Sets a custom constant sorting function.
+     *
+     * @param \Closure $func
+     */
     public function setConstantSortFunc(\Closure $func = null)
     {
         $this->constantSortFunc = $func;
     }
 
+    /**
+     * Sets a custom property sorting function.
+     *
+     * @param \Closure $func
+     */
     public function setPropertySortFunc(\Closure $func = null)
     {
         $this->propertySortFunc = $func;
     }
 
+    /**
+     * Sets a custom method sorting function.
+     *
+     * @param \Closure $func
+     */
     public function setMethodSortFunc(\Closure $func = null)
     {
         $this->methodSortFunc = $func;

src/CG/Generator/DefaultVisitor.php

@@ -2,6 +2,11 @@
 
 namespace CG\Generator;
 
+/**
+ * The default code generation visitor.
+ *
+ * @author Johannes M. Schmitt <[email protected]>
+ */
 class DefaultVisitor implements DefaultVisitorInterface
 {
     private $writer;

src/CG/Generator/DefaultVisitorInterface.php

@@ -2,9 +2,20 @@
 
 namespace CG\Generator;
 
+/**
+ * The visitor interface required by the DefaultNavigator.
+ *
+ * @author Johannes M. Schmitt <[email protected]>
+ */
 interface DefaultVisitorInterface
 {
+    /**
+     * Resets the visitors internal state to allow re-using the same instance.
+     *
+     * @return void
+     */
     function reset();
+
     function startVisitingClass(PhpClass $class);
     function startVisitingConstants();
     function visitConstant($name, $value);

src/CG/Generator/GeneratorUtils.php

@@ -2,6 +2,11 @@
 
 namespace CG\Generator;
 
+/**
+ * Some Generator utils.
+ *
+ * @author Johannes M. Schmitt <[email protected]>
+ */
 abstract class GeneratorUtils
 {
     private final function __construct() {}

src/CG/Generator/PhpClass.php

@@ -4,6 +4,11 @@
 
 use CG\Core\ReflectionUtils;
 
+/**
+ * Represents a PHP class.
+ *
+ * @author Johannes M. Schmitt <[email protected]>
+ */
 class PhpClass
 {
     private $name;

src/CG/Generator/PhpMethod.php

@@ -4,6 +4,11 @@
 
 use CG\Core\ReflectionUtils;
 
+/**
+ * Represents a PHP method.
+ *
+ * @author Johannes M. Schmitt <[email protected]>
+ */
 class PhpMethod extends AbstractPhpMember
 {
     private $final = false;

src/CG/Generator/PhpParameter.php

@@ -2,6 +2,11 @@
 
 namespace CG\Generator;
 
+/**
+ * Represents a PHP parameter.
+ *
+ * @author Johannes M. Schmitt <[email protected]>
+ */
 class PhpParameter
 {
     private $name;