comodojo / dispatcher.framework

src/Cache.php

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
      * Constructor method. It only acquire current time and notify that cache is ready
      *
      * @param   float   $time   Dispatcher time
-     * @param   Object  $logger Logger, injected by dispatcher
+     * @param   Debug  $logger Logger, injected by dispatcher
      */
     final public function __construct($time, $logger) {
 

src/Events.php

Doc Comments +2 added lines, -1 removed lines

@@ -47,6 +47,7 @@ 
      * It does nothing special: called at boot time, only notify that events
      * are ready.
      *
+     * @param Debug $logger
      * @return null
      */
     final public function __construct($logger) {
@@ -66,7 +67,7 @@ 
      * @param   string  $callback   Callback (or callback class)
      * @param   string  $method     (optional) callback method
      *
-     * @return  Object  $this
+     * @return  Events  $this
      */
     final public function add($event, $callback, $method=null) {
 

src/Header.php

Doc Comments +5 added lines, -5 removed lines

@@ -57,8 +57,8 @@ 
      * Set $header with a $value. If value is null, only $header will be used
      *
      * @param   string  $header   Header name
-     * @param   mixed   $value    Header value (if not included in $header)
-     * @return  Object  $this
+     * @param   string   $value    Header value (if not included in $header)
+     * @return  Header  $this
      */
     final public function set($header, $value=null) {
 
@@ -86,7 +86,7 @@ 
     /**
      * Free recorded headers (re-init array)
      *
-     * @return  Object  $this
+     * @return  Header  $this
      */
     final public function free() {
 
@@ -231,7 +231,7 @@ 
      * Shortcut to set client cache headers
      *
      * @param   integer     $ttl    Cache time to live
-     * @return  Object      $this
+     * @return  Header      $this
      */
     public function setClientCache($ttl) {
 
@@ -255,7 +255,7 @@ 
      *
      * @param   string      $type       Content type
      * @param   string      $charset    Charset
-     * @return  Object      $this
+     * @return  Header      $this
      */
     public function setContentType($type, $charset=null) {
 

src/ObjectRoute/ObjectRoute.php

Doc Comments +7 added lines, -7 removed lines

@@ -60,7 +60,7 @@ 
      *
      * @param   string  $service    The service name
      *
-     * @return  Object  $this
+     * @return  ObjectRoute  $this
      */
     public function setService($service) {
 
@@ -85,7 +85,7 @@ 
      *
      * @param   string  $type
      *
-     * @return  Object  $this
+     * @return  ObjectRoute  $this
      */
     public function setType($type) {
 
@@ -113,7 +113,7 @@ 
      *
      * @param   string  $target
      *
-     * @return  Object  $this
+     * @return  ObjectRoute  $this
      */
     public function setTarget($target) {
 
@@ -239,7 +239,7 @@ 
      * @param   string  $header     Header name
      * @param   string  $value      Header content (optional)
      *
-     * @return  ObjectRequest   $this
+     * @return  ObjectRoute   $this
      */
     public function setHeader($header, $value=null) {
 
@@ -290,7 +290,7 @@ 
      *
      * @param   array   $headers    Headers array
      *
-     * @return  ObjectRequest   $this
+     * @return  ObjectRoute   $this
      */
     public function setHeaders($headers) {
 
@@ -303,7 +303,7 @@ 
     /**
      * Unset headers
      *
-     * @return  ObjectRequest   $this
+     * @return  ObjectRoute   $this
      */
     public function unsetHeaders() {
 
@@ -327,7 +327,7 @@ 
     /**
      * Set extra parameter
      *
-     * @return  ObjectRequest   $this
+     * @return  ObjectRoute   $this
      */
     public function setParameter($parameter, $value=null) {
 

src/Service/Service.php

Doc Comments +11 added lines, -11 removed lines

@@ -260,7 +260,7 @@ 
      * @param   array   $attributes array og attributes that service expects
      * @param   array   $parameters array of parameters that service expects
      *
-     * @return  Object  $this
+     * @return  Service  $this
      */
     final public function expects($method, $attributes, $parameters=array()) {
 
@@ -280,7 +280,7 @@ 
      * @param   array   $attributes array og attributes that service likes
      * @param   array   $parameters array of parameters that service likes
      *
-     * @return  Object  $this
+     * @return  Service  $this
      */
     final public function likes($method, $attributes, $parameters=array()) {
 
@@ -306,7 +306,7 @@ 
      *
      * @param   string  $methods     HTTP methods, comma separated
      *
-     * @return  Object  $this
+     * @return  Service  $this
      */
     final public function setSupportedMethods($methods) {
 
@@ -331,7 +331,7 @@ 
      * Set service content type
      *
      * @param   string  $type   Content Type
-     * @return  Object  $this
+     * @return  Service  $this
      */
     final public function setContentType($type) {
 
@@ -357,7 +357,7 @@ 
      *
      * @param   string  $charset   Charset
      *
-     * @return  Object  $this
+     * @return  Service  $this
      */
     final public function setCharset($charset) {
 
@@ -382,7 +382,7 @@ 
      * Set success status code
      *
      * @param   integer $code   HTTP status code (in case of success)
-     * @return  Object  $this
+     * @return  Service  $this
      */
     final public function setStatusCode($code) {
 
@@ -433,7 +433,7 @@ 
      * @param   string  $header     Header name
      * @param   string  $value      Header content (optional)
      *
-     * @return  Object  $this
+     * @return  Service  $this
      */
     final public function setHeader($header, $value=null) {
 
@@ -484,7 +484,7 @@ 
      *
      * @param   array   $headers    Headers array
      *
-     * @return  Object  $this
+     * @return  Service  $this
      */
     final public function setHeaders($headers) {
 
@@ -497,7 +497,7 @@ 
     /**
      * Unset headers
      *
-     * @return  Object  $this
+     * @return  Service  $this
      */
     final public function unsetHeaders() {
 
@@ -521,7 +521,7 @@ 
     /**
      * Get service-supported HTTP methods
      *
-     * @return  array   Headers array
+     * @return  string   Headers array
      */
     final public function getSupportedMethods() {
 
@@ -555,7 +555,7 @@ 
     /**
      * Return the callable class method that reflect the requested one
      *
-     * @return  array   Headers array
+     * @return  string   Headers array
      */
     final public function getCallableMethod($method) {
 

src/Dispatcher.php

Doc Comments +6 added lines, -3 removed lines

@@ -375,7 +375,7 @@ 
     /**
      * Dispatcher working method
      *
-     * @return  mixed
+     * @return  string
      */
     final public function dispatch() {
 
@@ -696,7 +696,7 @@ 
     /**
      * Return dispatcher baseurl, no matter the request
      *
-     * @return uri  The baseurl
+     * @return string  The baseurl
      */
     private function urlGetAbsolute($service=null) {
 
@@ -845,6 +845,9 @@ 
 
     }
 
+    /**
+     * @return ObjectResultInterface
+     */
     private function runService(ObjectRequest $request, ObjectRoute $route) {
 
         $method = $request->getMethod();
@@ -977,7 +980,7 @@ 
     /**
      * Route request handling ObjectResult hooks
      *
-     * @param   ObjectResult    $route  An implementation of ObjectResultInterface
+     * @param   ObjectResultInterface    $route  An implementation of ObjectResultInterface
      * @return  string                  Content (stuff that will go on screen)
      */
     private function route(ObjectResultInterface $route) {

src/XML.php

Doc Comments +6 added lines, -4 removed lines

@@ -116,7 +116,7 @@ 
      *
      * @param bool $bool
      *
-     * @return Object $this
+     * @return XML $this
      */
     final public function setIncludeHeader($bool) {
 
@@ -131,7 +131,7 @@ 
      *
      * @param int $int
      *
-     * @return Object $this
+     * @return XML $this
      */
     final public function setCaseFolding($int) {
 
@@ -146,7 +146,7 @@ 
      *
      * @param int $int
      *
-     * @return Object $this
+     * @return XML $this
      */
     final public function setSkipWhite($int) {
 
@@ -161,7 +161,7 @@ 
      *
      * @param string $encoding
      *
-     * @return Object $this
+     * @return XML $this
      */
     final public function setEncoding($encoding) {
 
@@ -219,6 +219,7 @@ 
     /**
      * encode XML string into array
      *
+     * @param string $xml
      * @return array
      */
     public function decode($xml, $encoding=null) {
@@ -306,6 +307,7 @@ 
     /**
      * Get element childs (if any)
      *
+     * @param integer $i
      * @return array
      */
     private function getChilds(&$i) {