From cc61c2d74e151a7fb75303f8740edfe74cdd9eb8 Mon Sep 17 00:00:00 2001 From: wei <> Date: Thu, 11 May 2006 11:35:35 +0000 Subject: Update api docs and add API search --- framework/I18N/TGlobalizationAutoDetect.php | 20 ++++++++++++++++---- framework/I18N/core/CultureInfo.php | 2 +- framework/I18N/core/MessageSource.php | 2 +- framework/TComponent.php | 2 +- framework/Util/TDataFieldAccessor.php | 2 +- framework/Web/Javascripts/TJSON.php | 1 - framework/Web/TAssetManager.php | 3 ++- framework/Web/THttpResponse.php | 2 +- framework/Web/THttpSession.php | 10 ++++++---- framework/Web/UI/WebControls/TBaseValidator.php | 3 ++- framework/Web/UI/WebControls/TMultiView.php | 2 +- 11 files changed, 32 insertions(+), 17 deletions(-) (limited to 'framework') diff --git a/framework/I18N/TGlobalizationAutoDetect.php b/framework/I18N/TGlobalizationAutoDetect.php index 3d550a62..7393d79a 100644 --- a/framework/I18N/TGlobalizationAutoDetect.php +++ b/framework/I18N/TGlobalizationAutoDetect.php @@ -1,15 +1,27 @@ + * @link http://www.pradosoft.com/ + * @copyright Copyright © 2005 PradoSoft + * @license http://www.pradosoft.com/license/ + * @version $Revision: 1.66 $ $Date: ${DATE} ${TIME} $ + * @package System.I18N + */ +/** + * Import the HTTPNeogtiator + */ Prado::using('System.I18N.core.HTTPNegotiator'); /** - * ${classname} - * - * ${description} + * TGlobalizationAutoDetect class will automatically try to resolve the default + * culture using the user browser language settings. * * @author Wei Zhuo * @version $Revision: 1.66 $ $Date: ${DATE} ${TIME} $ - * @package ${package} + * @package System.I18N */ class TGlobalizationAutoDetect extends TGlobalization { diff --git a/framework/I18N/core/CultureInfo.php b/framework/I18N/core/CultureInfo.php index fe2c45e6..299a8b16 100644 --- a/framework/I18N/core/CultureInfo.php +++ b/framework/I18N/core/CultureInfo.php @@ -161,7 +161,7 @@ class CultureInfo * Initializes a new instance of the CultureInfo class based on the * culture specified by name. E.g. new CultureInfo('en_AU'); * The culture indentifier must be of the form - * "_(country/region/variant)". + * "language_(country/region/variant)". * @param string a culture name, e.g. "en_AU". * @return return new CultureInfo. */ diff --git a/framework/I18N/core/MessageSource.php b/framework/I18N/core/MessageSource.php index d69a13d9..6563f8c9 100644 --- a/framework/I18N/core/MessageSource.php +++ b/framework/I18N/core/MessageSource.php @@ -121,7 +121,7 @@ abstract class MessageSource implements IMessageSource * @param string the location of the resource. * @param string the filename of the custom message source. * @return MessageSource a new message source of the specified type. - * @throw InvalidMessageSourceTypeException + * @throws InvalidMessageSourceTypeException */ static function &factory($type, $source='.', $filename='') { diff --git a/framework/TComponent.php b/framework/TComponent.php index 64854692..5501f137 100644 --- a/framework/TComponent.php +++ b/framework/TComponent.php @@ -397,7 +397,7 @@ class TComponent * Evaluates a list of PHP statements. * @param string PHP statements * @return string content echoed or printed by the PHP statements - * @throw TInvalidOperationException if the statements are invalid + * @throws TInvalidOperationException if the statements are invalid */ public function evaluateStatements($statements) { diff --git a/framework/Util/TDataFieldAccessor.php b/framework/Util/TDataFieldAccessor.php index 09512a28..6af972e9 100644 --- a/framework/Util/TDataFieldAccessor.php +++ b/framework/Util/TDataFieldAccessor.php @@ -46,7 +46,7 @@ class TDataFieldAccessor * @param mixed data containing the field value, can be an array, TMap, TList or object. * @param mixed field value * @return mixed value at the specified field - * @throw TInvalidDataValueException if field or data is invalid + * @throws TInvalidDataValueException if field or data is invalid */ public static function getDataFieldValue($data,$field) { diff --git a/framework/Web/Javascripts/TJSON.php b/framework/Web/Javascripts/TJSON.php index e653264b..63f77b40 100644 --- a/framework/Web/Javascripts/TJSON.php +++ b/framework/Web/Javascripts/TJSON.php @@ -45,7 +45,6 @@ * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH * DAMAGE. * -* @category * @package System.Web.Javascripts * @author Michal Migurski * @author Matt Knapp diff --git a/framework/Web/TAssetManager.php b/framework/Web/TAssetManager.php index deae32ff..9a4ad3e5 100644 --- a/framework/Web/TAssetManager.php +++ b/framework/Web/TAssetManager.php @@ -148,7 +148,8 @@ class TAssetManager extends TModule * @param boolean If true, file modification time will be checked even if the application * is in performance mode. * @return string an absolute URL to the published directory - * @throw TInvalidDataValueException if the file path to be published is invalid + * @throws TInvalidDataValueException if the file path to be published is + * invalid */ public function publishFilePath($path,$checkTimestamp=false) { diff --git a/framework/Web/THttpResponse.php b/framework/Web/THttpResponse.php index ce4bf4b1..582a3db3 100644 --- a/framework/Web/THttpResponse.php +++ b/framework/Web/THttpResponse.php @@ -129,7 +129,7 @@ class THttpResponse extends TModule implements ITextWriter } /** - * @string content type, default is text/html + * @return string content type, default is text/html */ public function setContentType($type) { diff --git a/framework/Web/THttpSession.php b/framework/Web/THttpSession.php index fa53022d..13526dd1 100644 --- a/framework/Web/THttpSession.php +++ b/framework/Web/THttpSession.php @@ -45,14 +45,16 @@ * request module. It can be accessed via {@link TApplication::getSession()}. * * THttpSession may be configured in application configuration file as follows, + * * + * * where {@link getSessionName SessionName}, {@link getSavePath SavePath}, - * {@link getCookieMode CookieMode}, {@link getUseCustomStorage UseCustomStorage}, - * {@link getAutoStart AutoStart}, {@link getGCProbability GCProbability}, - * {@link getUseTransparentSessionID UseTransparentSessionID} and - * {@link getTimeOut TimeOut} are configurable properties of THttpSession. + * {@link getCookieMode CookieMode}, {@link getUseCustomStorage + * UseCustomStorage}, {@link getAutoStart AutoStart}, {@link getGCProbability + * GCProbability}, {@link getUseTransparentSessionID UseTransparentSessionID} + * and {@link getTimeOut TimeOut} are configurable properties of THttpSession. * * @author Qiang Xue * @version $Revision: $ $Date: $ diff --git a/framework/Web/UI/WebControls/TBaseValidator.php b/framework/Web/UI/WebControls/TBaseValidator.php index ea1a5836..8fcba1c2 100644 --- a/framework/Web/UI/WebControls/TBaseValidator.php +++ b/framework/Web/UI/WebControls/TBaseValidator.php @@ -414,7 +414,8 @@ abstract class TBaseValidator extends TLabel implements IValidator /** * @return TControl control to be validated. Null if no control is found. - * @throw TConfigurationException if {@link getControlToValidate ControlToValidate} is empty or does not point to a valid control + * @throws TConfigurationException if {@link getControlToValidate + * ControlToValidate} is empty or does not point to a valid control */ protected function getValidationTarget() { diff --git a/framework/Web/UI/WebControls/TMultiView.php b/framework/Web/UI/WebControls/TMultiView.php index 6dd0d8f1..59b9f53d 100644 --- a/framework/Web/UI/WebControls/TMultiView.php +++ b/framework/Web/UI/WebControls/TMultiView.php @@ -369,7 +369,7 @@ class TView extends TControl /** * @param boolean - * @throw TInvalidOperationException whenever this method is invoked. + * @throws TInvalidOperationException whenever this method is invoked. */ public function setVisible($value) { -- cgit v1.2.3