Skip to content
Permalink
Browse files

Correct documentation.

Options are traditionally above the @param block as it results in easier
to read API docs.
  • Loading branch information...
markstory committed Jul 12, 2013
1 parent 1ecc921 commit b3273e9cc2427360c4bf3a10eade2654cd35b8ee
Showing with 10 additions and 6 deletions.
  1. +10 −6 lib/Cake/Network/CakeResponse.php
@@ -1206,13 +1206,18 @@ public function cookie($options = null) {
}
/**
* Setup for display or download the given file
* Setup for display or download the given file.
*
* If $_SERVER['HTTP_RANGE'] is set a slice of the file will be
* returned instead of the entire file.
*
* ### Options keys
*
* - name: Alternate download name
* - download: If `true` sets download header and forces file to be downloaded rather than displayed in browser
*
* @param string $path Path to file
* @param array $options Options
* ### Options keys
* - name: Alternate download name
* - download: If `true` sets download header and forces file to be downloaded rather than displayed in browser
* @param array $options Options See above.
* @return void
* @throws NotFoundException
*/
@@ -1283,7 +1288,6 @@ public function file($path, $options = array()) {
$this->header('Content-Length', $fileSize);
}
$this->_clearBuffer();
$this->_file = $file;
}

0 comments on commit b3273e9

Please sign in to comment.
You can’t perform that action at this time.