Correct documentation.

Options are traditionally above the @param block as it results in easier
to read API docs.
This commit is contained in:
mark_story 2013-07-11 20:59:52 -04:00
parent 1ecc921e13
commit b3273e9cc2

View file

@ -1206,13 +1206,18 @@ class CakeResponse {
} }
/** /**
* 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 string $path Path to file
* @param array $options Options * @param array $options Options See above.
* ### Options keys
* - name: Alternate download name
* - download: If `true` sets download header and forces file to be downloaded rather than displayed in browser
* @return void * @return void
* @throws NotFoundException * @throws NotFoundException
*/ */
@ -1283,7 +1288,6 @@ class CakeResponse {
$this->header('Content-Length', $fileSize); $this->header('Content-Length', $fileSize);
} }
$this->_clearBuffer(); $this->_clearBuffer();
$this->_file = $file; $this->_file = $file;
} }