Merge pull request #1 from Linfuby/master

PHPDoc

Author: dracony

src/PHPixie/Framework.php

@@ -4,6 +4,9 @@
 
 abstract class Framework
 {
+    /**
+     * @type Framework\Builder
+     */
     protected $builder;
 
     public function __construct()

src/PHPixie/Framework/Assets.php

@@ -4,6 +4,9 @@
 
 class Assets
 {
+    /**
+     * @type Components
+     */
     protected $components;
     protected $instances = array();
 

src/PHPixie/Framework/Builder.php

@@ -5,32 +5,50 @@
 abstract class Builder
 {
     protected $instances = array();
-    
+
+    /**
+     * @return Assets
+     */
     public function assets()
     {
         return $this->instance('assets');
     }
-    
+
+    /**
+     * @return Components
+     */
     public function components()
     {
         return $this->instance('components');
     }
-    
+
+    /**
+     * @return Context
+     */
     public function context()
     {
         return $this->instance('context');
     }
-    
+
+    /**
+     * @return Extensions
+     */
     public function extensions()
     {
         return $this->instance('extensions');
     }
-    
+
+    /**
+     * @return HTTP
+     */
     public function http()
     {
         return $this->instance('http');
     }
-    
+
+    /**
+     * @return Processors
+     */
     public function processors()
     {
         return $this->instance('processors');

src/PHPixie/Framework/Components.php

@@ -4,89 +4,143 @@
 
 class Components
 {
+    /**
+     * @type Builder
+     */
     protected $builder;
     protected $instances = array();
-    
+
+    /**
+     * @param Builder $builder
+     */
     public function __construct($builder)
     {
         $this->builder = $builder;
     }
-    
+
+    /**
+     * @return \PHPixie\Slice
+     */
     public function slice()
     {
         return $this->instance('slice');
     }
-    
+
+    /**
+     * @return \PHPixie\Config
+     */
     public function config()
     {
         return $this->instance('config');
     }
-    
+
+    /**
+     * @return \PHPixie\Debug
+     */
     public function debug()
     {
         return $this->instance('debug');
     }
-    
+
+    /**
+     * @return \PHPixie\Database
+     */
     public function database()
     {
         return $this->instance('database');
     }
-    
+
+    /**
+     * @return \PHPixie\Filesystem
+     */
     public function filesystem()
     {
         return $this->instance('filesystem');
     }
-    
+
+    /**
+     * @return \PHPixie\HTTP
+     */
     public function http()
     {
         return $this->instance('http');
     }
-    
+
+    /**
+     * @return \PHPixie\HTTPProcessors
+     */
     public function httpProcessors()
     {
         return $this->instance('httpProcessors');
     }
-    
+
+    /**
+     * @return \PHPixie\ORM
+     */
     public function orm()
     {
         return $this->instance('orm');
     }
-    
+
+    /**
+     * @return \PHPixie\Processors
+     */
     public function processors()
     {
         return $this->instance('processors');
     }
-    
+
+    /**
+     * @return \PHPixie\Template
+     */
     public function template()
     {
         return $this->instance('template');
     }
-    
+
+    /**
+     * @return \PHPixie\Route
+     */
     public function route()
     {
         return $this->instance('route');
     }
-    
+
+    /**
+     * @return \PHPixie\Security
+     */
     public function security()
     {
         return $this->instance('security');
     }
-    
+
+    /**
+     * @return \PHPixie\Auth
+     */
     public function auth()
     {
         return $this->instance('auth');
     }
-    
+
+    /**
+     * @return \PHPixie\AuthProcessors
+     */
     public function authProcessors()
     {
         return $this->instance('authProcessors');
     }
-    
+
+    /**
+     * @return \PHPixie\Paginate
+     */
     public function paginate()
     {
         return $this->instance('paginate');
     }
-    
+
+    /**
+     * @return \PHPixie\PaginateORM
+     */
     public function paginateOrm()
     {
         return $this->instance('paginateOrm');

src/PHPixie/Framework/Context.php

@@ -7,7 +7,10 @@ class Context implements \PHPixie\HTTP\Context\Container\Settable,
 {
     protected $httpContext;
     protected $authContext;
-    
+
+    /**
+     * @return \PHPixie\HTTP\Context
+     */
     public function httpContext()
     {
         return $this->httpContext;
@@ -17,7 +20,10 @@ public function setHttpContext($httpContext)
     {
         $this->httpContext = $httpContext;
     }
-    
+
+    /**
+     * @return \PHPixie\Auth\Context
+     */
     public function authContext()
     {
         return $this->authContext;

src/PHPixie/Framework/Extensions.php

@@ -4,13 +4,16 @@
 
 class Extensions
 {
+    /**
+     * @type Builder
+     */
     protected $builder;
 
     public function __construct($builder)
     {
         $this->builder = $builder;
     }
-    
+
     public function templateExtensions()
     {
         return array(

src/PHPixie/Framework/Extensions/Template/Extension/RouteTranslator.php

@@ -6,6 +6,10 @@ class RouteTranslator implements \PHPixie\Template\Extensions\Extension
 {
 
     protected $name;
+
+    /**
+     * @type \PHPixie\Route\Translator
+     */
     protected $routeTranslator;
 
     public function __construct($name, $routeTranslator)

src/PHPixie/Framework/HTTP.php

@@ -4,6 +4,9 @@
 
 class HTTP
 {
+    /**
+     * @type Builder
+     */
     protected $builder;
     protected $configData;
 
@@ -18,7 +21,10 @@ public function processor()
     {
         return $this->instance('processor');
     }
-    
+
+    /**
+     * @return \PHPixie\Route\Translator
+     */
     public function routeTranslator()
     {
         return $this->instance('routeTranslator');

src/PHPixie/Framework/Processors.php

@@ -4,6 +4,9 @@
 
 class Processors
 {
+    /**
+     * @type Builder
+     */
     protected $builder;
 
     public function __construct($builder)

src/PHPixie/Framework/Processors/HTTP/ParseRoute.php

@@ -4,6 +4,9 @@
 
 class ParseRoute implements \PHPixie\Processors\Processor
 {
+    /**
+     * @type \PHPixie\Route\Translator
+     */
     protected $routeTranslator;
 
     public function __construct($routeTranslator)