Merge pull request #361 from shama/patch-route-docblocks

Move Route docblocks to make text available in the API

lib/Cake/Routing/Route/PluginShortRoute.php

@@ -1,10 +1,5 @@
 <?php
 /**
- * Plugin short route, that copies the plugin param to the controller parameters
- * It is used for supporting /:plugin routes.
- *
- * PHP5
- *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
  *
@@ -13,21 +8,21 @@
  *
  * @copyright     Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
  * @link          http://cakephp.org CakePHP(tm) Project
- * @package       Cake.Routing.Route
  * @since         CakePHP(tm) v 1.3
  * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
  */
 App::uses('CakeRoute', 'Routing/Route');
 
 /**
- * Plugin Short Route class
+ * Plugin short route, that copies the plugin param to the controller parameters
- * 
+ * It is used for supporting /:plugin routes.
+ *
  * @package Cake.Routing.Route
  */
 class PluginShortRoute extends CakeRoute {
 
 /**
- * Parses a string url into an array.  If a plugin key is found, it will be copied to the
+ * Parses a string url into an array. If a plugin key is found, it will be copied to the
  * controller parameter
  *
  * @param string $url The url to parse
@@ -43,7 +38,7 @@ class PluginShortRoute extends CakeRoute {
 	}
 
 /**
- * Reverse route plugin shortcut urls.  If the plugin and controller
+ * Reverse route plugin shortcut urls. If the plugin and controller
  * are not the same the match is an auto fail.
  *
  * @param array $url Array of parameters to convert to a string.

lib/Cake/Routing/Route/RedirectRoute.php

@@ -1,11 +1,5 @@
 <?php
 /**
- * Redirect route will perform an immediate redirect.  Redirect routes
- * are useful when you want to have Routing layer redirects occur in your
- * application, for when URLs move.
- *
- * PHP5
- *
  * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  * Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
  *
@@ -22,7 +16,9 @@ App::uses('CakeResponse', 'Network');
 App::uses('CakeRoute', 'Routing/Route');
 
 /**
- * Redirect Route class
+ * Redirect route will perform an immediate redirect. Redirect routes
+ * are useful when you want to have Routing layer redirects occur in your
+ * application, for when URLs move.
  *
  * @package Cake.Routing.Route
  */
@@ -36,7 +32,7 @@ class RedirectRoute extends CakeRoute {
 	public $response = null;
 
 /**
- * The location to redirect to.  Either a string or a cake array url.
+ * The location to redirect to. Either a string or a cake array url.
  *
  * @var mixed
  */
@@ -105,7 +101,7 @@ class RedirectRoute extends CakeRoute {
 	}
 
 /**
- * Stop execution of the current script.  Wraps exit() making
+ * Stop execution of the current script. Wraps exit() making
  * testing easier.
  *
  * @param integer|string $status see http://php.net/exit for values