Tidying up code

Author: dantleech

AutoRoute/Mapping/ClassMetadata.php

@@ -21,9 +21,19 @@
  */
 class ClassMetadata extends MergeableClassMetadata
 {
+    /**
+     * @var string
+     */
     protected $urlSchema;
+
+    /**
+     * @var array
+     */
     protected $tokenProviders = array();
-    /** @var null|array */
+
+    /** 
+     * @var null|array
+     */
     protected $conflictResolver;
 
     /**
@@ -33,18 +43,40 @@ class ClassMetadata extends MergeableClassMetadata
      */
     protected $defunctRouteHandler = array('name' => 'remove');
 
-    protected $extend;
+    /**
+     * @var string
+     */
+    protected $extendedClass;
 
+    /**
+     * Set the URL schema to use for the subject class.
+     *
+     * e.g. {foobar}/articles/{date}
+     *
+     * @param string $schema
+     */
     public function setUrlSchema($schema)
     {
         $this->urlSchema = $schema;
     }
 
+    /**
+     * Return the URL schema
+     *
+     * @return string
+     */
     public function getUrlSchema()
     {
         return $this->urlSchema;
     }
 
+    /**
+     * Add a token provider configfuration.
+     *
+     * @param string $tokenName
+     * @param array $provider
+     * @param boolean $override
+     */
     public function addTokenProvider($tokenName, array $provider = array(), $override = false)
     {
         if ('schema' === $tokenName) {
@@ -58,21 +90,44 @@ public function addTokenProvider($tokenName, array $provider = array(), $overrid
         $this->tokenProviders[$tokenName] = $provider;
     }
 
+    /**
+     * Return an associative array of token provider configurations.
+     * Keys are the token provider names, values are configurations in
+     * array format.
+     *
+     * @return array
+     */
     public function getTokenProviders()
     {
         return $this->tokenProviders;
     }
 
+    /**
+     * Set the conflict resolver configuration.
+     *
+     * @param array
+     */
     public function setConflictResolver($conflictResolver)
     {
         $this->conflictResolver = $conflictResolver;
     }
 
+    /**
+     * Return the conflict resolver configuration.
+     *
+     * @return array
+     */
     public function getConflictResolver()
     {
         return $this->conflictResolver;
     }
 
+    /**
+     * Return true if a conflict resolver configuration
+     * has been registered.
+     *
+     * @return boolean
+     */
     public function hasConflictResolver()
     {
         return null !== $this->conflictResolver;
@@ -100,21 +155,41 @@ public function getDefunctRouteHandler()
         return $this->defunctRouteHandler;
     }
 
+    /**
+     * Return true if a defunct route handler has been set.
+     *
+     * @return boolean
+     */
     public function hasDefunctRouteHandler()
     {
         return null !== $this->defunctRouteHandler;
     }
 
+    /**
+     * Extend the metadata of the mapped class with given $name
+     *
+     * @param string $name
+     */
     public function setExtendedClass($name)
     {
-        $this->extend = $name;
+        $this->extendedClass = $name;
     }
 
+    /**
+     * Return the name of the extended class (if any)
+     *
+     * @return string
+     */
     public function getExtendedClass()
     {
-        return $this->extend;
+        return $this->extendedClass;
     }
 
+    /**
+     * Return the name of the subject class
+     *
+     * @return string
+     */
     public function getClassName()
     {
         return $this->name;

AutoRoute/Mapping/Loader/XmlFileLoader.php

@@ -16,6 +16,8 @@
 use Symfony\Component\Config\Loader\FileLoader;
 
 /**
+ * Loader for XML files
+ *
  * @author Wouter J <[email protected]>
  */
 class XmlFileLoader extends FileLoader

AutoRoute/Mapping/Loader/YmlFileLoader.php

@@ -20,7 +20,9 @@
  */
 class YmlFileLoader extends FileLoader
 {
-    /** @var null|YamlParser */
+    /** 
+     * @var null|YamlParser
+     */
     private $parser;
 
     /**

AutoRoute/Mapping/MetadataFactory.php

@@ -22,11 +22,19 @@
  */
 class MetadataFactory implements \IteratorAggregate, MetadataFactoryInterface
 {
-    /** @var ClassMetadata[] */
+    /** 
+     * @var ClassMetadata[]
+     */
     protected $metadatas = array();
-    /** @var ClassMetadata[] */
+
+    /**
+     * @var ClassMetadata[]
+     */
     protected $resolvedMetadatas = array();
-    /** @var null|CacheInterface */
+
+    /**
+     * @var null|CacheInterface
+     */
     protected $cache;
 
     /**

AutoRoute/Mapping/MetadataFactoryBuilder.php

@@ -13,20 +13,40 @@
 
 use Symfony\Component\Config\Loader\LoaderInterface;
 
+/**
+ * MetaFactoryBuilder
+ *
+ * @author Wouter J <[email protected]>
+ */
 class MetadataFactoryBuilder
 {
-    /** @var array */
+    /** 
+     * @var array 
+     */
     protected $resources;
-    /** @var LoaderInterface */
+
+    /** 
+     * @var LoaderInterface
+     */
     protected $loader;
 
+    /**
+     * @param LoaderInterface $loader
+     * @param array $resources
+     */
     public function __construct(LoaderInterface $loader, array $resources)
     {
         $this->loader = $loader;
         $this->resources = $resources;
     }
 
+    /**
+     * Return the metadata factory
+     *
+     * @return MetadataFactory
+     */
     public function getMetadataFactory()
+
     {
         $mappingFactory = new MetadataFactory();