frqnck / apix

src/php/Apix/Config.php

Doc Comments +3 added lines, -6 removed lines

@@ -110,7 +110,7 @@ 
     /**
      * Sets the config property and merge the defaults.
      *
-     * @param array $config=null
+     * @param array $config
      */
     public function setConfig(array $config=null)
     {
@@ -132,7 +132,7 @@ 
      * Returns the specified config value using its index key. If the index key
      * is not set then it will return the whole config property.
      *
-     * @param  string                    $key=null The key to retrieve.
+     * @param string $key
      * @return mixed
      * @throws \InvalidArgumentException
      */
@@ -175,7 +175,7 @@ 
      * Returns the specified default config value using its index key.
      * If the index key is not set then it will return the whole default config property.
      *
-     * @param  string                    $key=null The key to retrieve.
+     * @param string $key
      * @return mixed
      * @throws \InvalidArgumentException
      */
@@ -197,7 +197,6 @@ 
      * If an index key is specified return the corresponding (mixed) value.
      *
      * @param  string                    $type     The sub-array type to retrieve.
-     * @param  string                    $key=null A key to narrow the retrieval.
      * @return mixed
      * @throws \InvalidArgumentException
      */
@@ -222,7 +221,6 @@ 
     /**
      * Returns all the resources or as the specified.
      *
-     * @param string $key=null The resource key to retrieve.
      * @see     self::retrieve
      */
     public function getResources($key=null)
@@ -247,7 +245,6 @@ 
     /**
      * Returns the specified service -- or all if unspecified.
      *
-     * @param  string $key=null The service key to retrieve.
      * @see self::retrieve
      * @return mixed  Generally should return a callback
      */

src/php/Apix/Console/Main.php

Doc Comments +8 added lines

@@ -243,6 +243,11 @@ 
         exit;
     }
 
+    /**
+     * @param string $url
+     *
+     * @return string
+     */
     public function getContents($url, $method='GET', $body=null)
     {
         $opts = array('http' => array(
@@ -270,6 +275,9 @@ 
         return null;
     }
 
+    /**
+     * @param string $url
+     */
     protected function retrieveUpdate($url, $dest)
     {
         $temp = basename($dest, '.phar').'-temp.phar';

src/php/Apix/Entity.php

Doc Comments +2 added lines, -4 removed lines

@@ -140,7 +140,6 @@ 
      * Checks wether the current entity holds the specified method.
      *
      * @param  string  $method
-     * @param  array   $actions=null Use to override local actions.
      * @return boolean
      */
     public function hasMethod($method)
@@ -217,7 +216,7 @@ 
      * @param  \ReflectionFunctionAbstract $refMethod   A reflected method/function to introspect.
      * @param  string                      $httpMethod  A public method name e.g. GET, POST.
      * @param  array                       $routeParams An array of route parameters to check upon.
-     * @return array                       The array of validated and required parameters
+     * @return callable                       The array of validated and required parameters
      * @throws \BadMethodCallException     400
      */
     public function getValidatedParams(
@@ -302,7 +301,7 @@ 
     /**
      * Returns the redirect location.
      *
-     * @return string
+     * @return boolean
      */
     public function hasRedirect()
     {
@@ -322,7 +321,6 @@ 
     /**
      * Returns an array of method keys and action values.
      *
-     * @param  array $array
      * @return array
      */
     public function getActions()

src/php/Apix/Entity/EntityClass.php

Doc Comments +1 added lines

@@ -116,6 +116,7 @@
 
     /**
      * {@inheritdoc}
+     * @return \ReflectionFunctionAbstract
      */
     public function getMethod(Router $route)
     {

src/php/Apix/Entity/EntityClosure.php

Doc Comments +7 added lines, -4 removed lines

@@ -137,6 +137,11 @@ 
         return $method;
     }
 
+    /**
+     * @param string $method
+     *
+     * @return callable
+     */
     private function getAction($method)
     {
       return $this->actions[$method]['action'];
@@ -148,8 +153,7 @@ 
      * Adds a redirect.
      *
      * @param  string $location A  name
-     * @param  array  $resource The resource definition array
-     * @return void
+     * @return EntityClosure
      */
     public function redirect($location)
     {
@@ -161,8 +165,7 @@ 
     /**
      * Group a resource entity.
      *
-     * @param  string $name The group name
-     * @return void
+     * @return EntityClosure
      */
     public function group($title)
     {

src/php/Apix/Entity/EntityInterface.php

Doc Comments +1 added lines, -4 removed lines

@@ -20,7 +20,6 @@ 
     /**
      * Appends the given array definition and apply _local_ mappings.
      *
-     * @param  array $definitions
      * @return void
      */
     public function append(array $defs);
@@ -44,15 +43,13 @@ 
     /**
       * Gets the method
      *
-     * @param string $name
      * @return
-     */
+     \ReflectionFunctionAbstract
     public function getMethod(Router $route);
 
     /**
      * Sets the actions array.
      *
-     * @param  array $array=null An associative array of methods as keys and actions as values.
      * @return void
      */
     public function setActions(array $asso = null);

src/php/Apix/Exception.php

Doc Comments +1 added lines

@@ -81,6 +81,7 @@
      * Handles critical errors (output and logging).
      *
      * @param \Exception $e
+     * @param string $alt_msg
      * @return array
      */
     public static function criticalError(\Exception $e, $alt_msg) 

src/php/Apix/Listener.php

Doc Comments +1 added lines, -1 removed lines

@@ -137,6 +137,7 @@ 
      *
      * @param mix $plugin
      * @param mix $args
+     * @return \SplObserver
      */
     private function callPlugin($plugin, $args)
     {
@@ -156,7 +157,6 @@ 
     /**
      * Load the specified plugin
      *
-     * @param  string           $name The plugin name to load
      * @param  mix              $mix  The plugin options
      * @return boolean          True on success, false otherwise
      * @throws RuntimeException If the plugin does not exists

src/php/Apix/Main.php

Doc Comments +1 added lines, -1 removed lines

@@ -290,7 +290,7 @@
    /**
     * Returns the route object.
     *
-    * @return Router
+    * @return Entity
     */
     public function getRoute()
     {