Permalink
Browse files

Fix doc blocks accuracy

  • Loading branch information...
1 parent f46d938 commit 3558a6f2e6e8ae8e8129199d70818b6dcd2f67c4 @bcrowe bcrowe committed Jan 29, 2014
@@ -210,6 +210,7 @@ public function app_uses() {
* Replace all the App::uses() calls with `use`.
*
* @param string $file The file to search and replace.
+ * @return mixed Replacement of uses call
*/
protected function _replaceUses($file) {
$pattern = '#App::uses\([\'"]([a-z0-9_]+)[\'"],\s*[\'"]([a-z0-9/_]+)(?:\.([a-z0-9/_]+))?[\'"]\)#i';
@@ -57,6 +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 void
*/
public function allow($aro, $aco, $action = "*") {
}
@@ -67,6 +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 void
*/
public function deny($aro, $aco, $action = "*") {
}
@@ -77,6 +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 void
*/
public function inherit($aro, $aco, $action = "*") {
}
@@ -192,10 +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 void
*/
public function unauthenticated(Request $request, Response $response) {
}
@@ -736,6 +736,7 @@ public function beforeRender(Event $event) {
* 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) {
@@ -745,6 +746,7 @@ public function beforeRedirect(Event $event, $url, $status = null, $exit = true)
* Called after the controller action is run and rendered.
*
* @param Event $event An Event instance
+ * @return void
* @link http://book.cakephp.org/2.0/en/controllers.html#request-life-cycle-callbacks
*/
public function afterFilter(Event $event) {
@@ -154,6 +154,7 @@ protected function _quoteJoins($joins) {
* Quotes the table name and columns for an insert query
*
* @param Query $query
+ * @return void
*/
protected function _quoteInsert($query) {
list($table, $columns) = $query->clause('insert');

0 comments on commit 3558a6f

Please sign in to comment.