From 9d46f8e4fc93a646da8dc82de661973adb4c0378 Mon Sep 17 00:00:00 2001 From: Carsten Brandt Date: Sun, 26 May 2013 01:48:01 +0200 Subject: [PATCH] added doc comment to Console::getScreensize() --- framework/yii/helpers/base/Console.php | 3 +++ 1 file changed, 3 insertions(+) diff --git a/framework/yii/helpers/base/Console.php b/framework/yii/helpers/base/Console.php index c8b89c4..6ad0b7b 100644 --- a/framework/yii/helpers/base/Console.php +++ b/framework/yii/helpers/base/Console.php @@ -574,6 +574,9 @@ class Console /** * Usage: list($w, $h) = ConsoleHelper::getScreenSize(); * + * @param bool $refresh whether to force checking and not re-use cached size value. + * This is useful to detect changing window size while the application is running but may + * not get up to date values on every terminal. * @return array|boolean An array of ($width, $height) or false when it was not able to determine size. */ public static function getScreenSize($refresh = false)