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/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 +-
 6 files changed, 12 insertions(+), 9 deletions(-)

(limited to 'framework/Web')

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 <mike-json@teczno.com>
 * @author      Matt Knapp <mdknapp[at]gmail[dot]com>
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,
+ * <code>
  * <module id="session" class="THttpSession" SessionName="SSID" SavePath="/tmp"
  *         CookieMode="Allow" UseCustomStorage="false" AutoStart="true" GCProbability="1"
  *         UseTransparentSessionID="true" TimeOut="3600" />
+ * </code>
  * 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 <qiang.xue@gmail.com>
  * @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