Some phpdoc fixes from scrutinizer.

This commit is contained in:
Robert Korulczyk
2016-11-12 22:11:30 +01:00
parent cf0952406d
commit 450eefaa50
4 changed files with 8 additions and 8 deletions

View File

@ -196,7 +196,7 @@ abstract class ErrorHandler extends Component
* @param string $message the error message. * @param string $message the error message.
* @param string $file the filename that the error was raised in. * @param string $file the filename that the error was raised in.
* @param int $line the line number the error was raised at. * @param int $line the line number the error was raised at.
* @return bool whether the normal error handler continues. * @return false whether the normal error handler continues.
* *
* @throws ErrorException * @throws ErrorException
*/ */

View File

@ -71,7 +71,7 @@ class CacheController extends Controller
public function actionFlush() public function actionFlush()
{ {
$cachesInput = func_get_args(); $cachesInput = func_get_args();
if (empty($cachesInput)) { if (empty($cachesInput)) {
throw new Exception('You should specify cache components names'); throw new Exception('You should specify cache components names');
} }

View File

@ -79,7 +79,7 @@ class MessageFormatter extends Component
* @param string $pattern The pattern string to insert parameters into. * @param string $pattern The pattern string to insert parameters into.
* @param array $params The array of name value pairs to insert into the format string. * @param array $params The array of name value pairs to insert into the format string.
* @param string $language The locale to use for formatting locale-dependent parts * @param string $language The locale to use for formatting locale-dependent parts
* @return string|bool The formatted pattern string or `FALSE` if an error occurred * @return string|false The formatted pattern string or `false` if an error occurred
*/ */
public function format($pattern, $params, $language) public function format($pattern, $params, $language)
{ {
@ -259,7 +259,7 @@ class MessageFormatter extends Component
* @param string $pattern The pattern string to insert things into. * @param string $pattern The pattern string to insert things into.
* @param array $args The array of values to insert into the format string * @param array $args The array of values to insert into the format string
* @param string $locale The locale to use for formatting locale-dependent parts * @param string $locale The locale to use for formatting locale-dependent parts
* @return string|bool The formatted pattern string or `FALSE` if an error occurred * @return false|string The formatted pattern string or `false` if an error occurred
*/ */
protected function fallbackFormat($pattern, $args, $locale) protected function fallbackFormat($pattern, $args, $locale)
{ {

View File

@ -30,7 +30,7 @@ use yii\helpers\Url;
* ], * ],
* ] * ]
* ``` * ```
* *
* For more details and usage information on AssetManager, see the [guide article on assets](guide:structure-assets). * For more details and usage information on AssetManager, see the [guide article on assets](guide:structure-assets).
* *
* @property AssetConverterInterface $converter The asset converter. Note that the type of this property * @property AssetConverterInterface $converter The asset converter. Note that the type of this property
@ -328,7 +328,7 @@ class AssetManager extends Component
* Returns the actual file path for the specified asset. * Returns the actual file path for the specified asset.
* @param AssetBundle $bundle the asset bundle which the asset file belongs to * @param AssetBundle $bundle the asset bundle which the asset file belongs to
* @param string $asset the asset path. This should be one of the assets listed in [[js]] or [[css]]. * @param string $asset the asset path. This should be one of the assets listed in [[js]] or [[css]].
* @return string|bool the actual file path, or false if the asset is specified as an absolute URL * @return string|false the actual file path, or `false` if the asset is specified as an absolute URL
*/ */
public function getAssetPath($bundle, $asset) public function getAssetPath($bundle, $asset)
{ {
@ -464,7 +464,7 @@ class AssetManager extends Component
/** /**
* Publishes a file. * Publishes a file.
* @param string $src the asset file to be published * @param string $src the asset file to be published
* @return array the path and the URL that the asset is published as. * @return string[] the path and the URL that the asset is published as.
* @throws InvalidParamException if the asset to be published does not exist. * @throws InvalidParamException if the asset to be published does not exist.
*/ */
protected function publishFile($src) protected function publishFile($src)
@ -509,7 +509,7 @@ class AssetManager extends Component
* it is found in the target directory. This option is used only when publishing a directory. * it is found in the target directory. This option is used only when publishing a directory.
* This overrides [[forceCopy]] if set. * This overrides [[forceCopy]] if set.
* *
* @return array the path directory and the URL that the asset is published as. * @return string[] the path directory and the URL that the asset is published as.
* @throws InvalidParamException if the asset to be published does not exist. * @throws InvalidParamException if the asset to be published does not exist.
*/ */
protected function publishDirectory($src, $options) protected function publishDirectory($src, $options)