Merge pull request #2720 from bcrowe/3.0-apigen

3.0 - Remove nonexistent params and returns

src/Console/Command/UpgradeShell.php

@@ -210,7 +210,6 @@ public function app_uses() {
  * Replace all the App::uses() calls with `use`.
  *
  * @param string $file The file to search and replace.
- * @param boolean $dryRun Whether or not to do the thing
  * @return mixed Replacement of uses call
  */
 	protected function _replaceUses($file) {

src/Controller/Component/Acl/IniAcl.php

@@ -57,7 +57,7 @@ public function initialize(Component $component) {
  * @param string $aro ARO The requesting object identifier.
  * @param string $aco ACO The controlled object identifier.
  * @param string $action Action (defaults to *)
- * @return boolean Success
+ * @return void
  */
 	public function allow($aro, $aco, $action = "*") {
 	}
@@ -68,7 +68,7 @@ public function allow($aro, $aco, $action = "*") {
  * @param string $aro ARO The requesting object identifier.
  * @param string $aco ACO The controlled object identifier.
  * @param string $action Action (defaults to *)
- * @return boolean Success
+ * @return void
  */
 	public function deny($aro, $aco, $action = "*") {
 	}
@@ -79,7 +79,7 @@ public function deny($aro, $aco, $action = "*") {
  * @param string $aro ARO The requesting object identifier.
  * @param string $aco ACO The controlled object identifier.
  * @param string $action Action (defaults to *)
- * @return boolean Success
+ * @return void
  */
 	public function inherit($aro, $aco, $action = "*") {
 	}

src/Controller/Component/Auth/BaseAuthenticate.php

@@ -192,12 +192,13 @@ public function getUser(Request $request) {
 	}
 
 /**
- * Handle unauthenticated access attempt.
+ * Handle unauthenticated access attempt. In implementation, will return true to indicate
+ * the unauthenticated request has been dealt with and no more action is required by
+ * AuthComponent or void (default).
  *
  * @param Cake\Network\Request $request A request object.
  * @param Cake\Network\Response $response A response object.
- * @return mixed Either true to indicate the unauthenticated request has been
- *  dealt with and no more action is required by AuthComponent or void (default).
+ * @return void
  */
 	public function unauthenticated(Request $request, Response $response) {
 	}

src/Controller/Component/PaginatorComponent.php

@@ -274,7 +274,6 @@ public function getDefaults($alias, $defaults) {
  *
  * @param Table $object The model being paginated.
  * @param array $options The pagination options being used for this request.
- * @param array $whitelist The list of columns that can be used for sorting. If empty all keys are allowed.
  * @return array An array of options with sort + direction removed and replaced with order if possible.
  */
 	public function validateSort(Table $object, array $options) {

src/Controller/Component/RequestHandlerComponent.php

@@ -196,7 +196,6 @@ protected function _setExtension() {
  *   to the $data property of the controller, which can then be saved to a model object.
  *
  * @param Event $event The startup event that was fired.
- * @param Controller $controller A reference to the controller
  * @return void
  */
 	public function startup(Event $event) {
@@ -278,7 +277,6 @@ public function beforeRedirect(Event $event, $url, $response) {
  * "304 Not Modified" header.
  *
  * @param Event $event The Controller.beforeRender event.
- * @param Controller $controller
  * @return boolean false if the render process should be aborted
  */
 	public function beforeRender(Event $event) {

src/Controller/Controller.php

@@ -733,10 +733,10 @@ public function beforeRender(Event $event) {
  *     or an absolute URL
  * @param integer $status Optional HTTP status code (eg: 404)
  * @param boolean $exit If true, exit() will be called after the redirect
- * @return mixed
  *   false to stop redirection event,
  *   string controllers a new redirection URL or
  *   array with the keys url, status and exit to be used by the redirect method.
+ * @return void
  * @link http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacks
  */
 	public function beforeRedirect(Event $event, $url, $status = null, $exit = true) {

src/Database/Connection.php

@@ -86,7 +86,6 @@ class Connection {
  * Constructor
  *
  * @param array $config configuration for connecting to database
- * @return self
  */
 	public function __construct($config) {
 		$this->_config = $config;

src/Database/IdentifierQuoter.php

@@ -154,7 +154,7 @@ protected function _quoteJoins($joins) {
  * Quotes the table name and columns for an insert query
  *
  * @param Query $query
- * @return Query
+ * @return void
  */
 	protected function _quoteInsert($query) {
 		list($table, $columns) = $query->clause('insert');

src/Network/Http/Message.php

@@ -167,7 +167,6 @@ public function cookies() {
 /**
  * Get the HTTP version used.
  *
- * @param null|string $version
  * @return string
  */
 	public function version() {

src/ORM/Associations.php

@@ -133,7 +133,6 @@ public function saveParents(Table $table, Entity $entity, $associations, $option
  *
  * @param Table $table The table entity is for.
  * @param Entity $entity The entity to save associated data for.
- * @param Entity $entity The entity to save associated data for.
  * @param array $associations The list of associations to save children from.
  *   associations not in this list will not be saved.
  * @param array $options The options for the save operation.