From b13ce728aed3916500b2560ff203fc14799425be Mon Sep 17 00:00:00 2001
From: "Christophe.Boulain" <>
Date: Wed, 17 Feb 2010 13:55:18 +0000
Subject: Fixes various phpdoc problems
---
framework/Data/Common/Mssql/TMssqlCommandBuilder.php | 3 ++-
framework/Web/THttpSession.php | 12 ++++++------
framework/Web/UI/ActiveControls/TActiveButton.php | 12 ++++++------
framework/Web/UI/ActiveControls/TActiveControlAdapter.php | 2 +-
framework/Web/UI/ActiveControls/TActiveFileUpload.php | 3 ++-
framework/Web/UI/ActiveControls/TActiveImageButton.php | 10 +++++-----
framework/Web/UI/ActiveControls/TActiveLinkButton.php | 11 ++++++-----
framework/Web/UI/ActiveControls/TAutoComplete.php | 2 +-
framework/Web/UI/ActiveControls/TBaseActiveControl.php | 4 ++--
framework/Web/UI/ActiveControls/TCallback.php | 14 +++++++-------
framework/Web/UI/ActiveControls/TCallbackClientScript.php | 4 ++--
.../Web/UI/ActiveControls/TCallbackResponseAdapter.php | 4 ++--
framework/Web/UI/ActiveControls/TDraggable.php | 2 ++
framework/Web/UI/ActiveControls/TDropContainer.php | 5 ++++-
framework/Web/UI/WebControls/TKeyboard.php | 3 ++-
framework/Web/UI/WebControls/TTabPanel.php | 3 +++
16 files changed, 53 insertions(+), 41 deletions(-)
diff --git a/framework/Data/Common/Mssql/TMssqlCommandBuilder.php b/framework/Data/Common/Mssql/TMssqlCommandBuilder.php
index 1a0ad4ce..9f65304b 100644
--- a/framework/Data/Common/Mssql/TMssqlCommandBuilder.php
+++ b/framework/Data/Common/Mssql/TMssqlCommandBuilder.php
@@ -4,7 +4,7 @@
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @link http://www.pradosoft.com/
- * @copyright Copyright © 2005-2008 PradoSoft
+ * @copyright Copyright © 2005-2008 PradoSoft
* @license http://www.pradosoft.com/license/
* @version $Id: TDbCommandBuilder.php 1863 2007-04-12 12:43:49Z wei $
* @package System.Data.Common
@@ -72,6 +72,7 @@ class TMssqlCommandBuilder extends TDbCommandBuilder
* <li>
* No clauses should follow the ORDER BY clause, e.g. no COMPUTE or FOR clauses.
* </li>
+ * </ul>
*
* @param string SQL query string.
* @param integer maximum number of rows, -1 to ignore limit.
diff --git a/framework/Web/THttpSession.php b/framework/Web/THttpSession.php
index e9f815e5..bec4c126 100644
--- a/framework/Web/THttpSession.php
+++ b/framework/Web/THttpSession.php
@@ -14,8 +14,8 @@
* THttpSession class
*
* THttpSession provides session-level data management and the related configurations.
- * To start the session, call {@open}; to complete and send out session data, call {@close};
- * to destroy the session, call {@destroy}. If AutoStart is true, then the session
+ * To start the session, call {@link open}; to complete and send out session data, call {@link close};
+ * to destroy the session, call {@link destroy}. If AutoStart is true, then the session
* will be started once the session module is loaded and initialized.
*
* To access data stored in session, use THttpSession like an associative array. For example,
@@ -29,10 +29,10 @@
* </code>
*
* The following configurations are available for session:
- * {@link setAutoStart AutoStart}, {@link setCookie Cookie},
- * {@link setCacheLimiter, {@link setSavePath SavePath},
+ * {@link setAutoStart AutoStart}, {@link setCookieMode CookieMode},
+ * {@link setSavePath SavePath},
* {@link setUseCustomStorage UseCustomStorage}, {@link setGCProbability GCProbability},
- * {@link setCookieUsage CookieUsage}, {@link setTimeout Timeout}.
+ * {@link setTimeout Timeout}.
* See the corresponding setter and getter documentation for more information.
* Note, these properties must be set before the session is started.
*
@@ -54,7 +54,7 @@
* {@link getCookieMode CookieMode}, {@link getUseCustomStorage
* UseCustomStorage}, {@link getAutoStart AutoStart}, {@link getGCProbability
* GCProbability}, {@link getUseTransparentSessionID UseTransparentSessionID}
- * and {@link getTimeOut TimeOut} are configurable properties of THttpSession.
+ * and {@link getTimeout TimeOut} are configurable properties of THttpSession.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @version $Id$
diff --git a/framework/Web/UI/ActiveControls/TActiveButton.php b/framework/Web/UI/ActiveControls/TActiveButton.php
index 0990ff41..745a472e 100644
--- a/framework/Web/UI/ActiveControls/TActiveButton.php
+++ b/framework/Web/UI/ActiveControls/TActiveButton.php
@@ -4,7 +4,7 @@
*
* @author Wei Zhuo <weizhuo[at]gamil[dot]com>
* @link http://www.pradosoft.com/
- * @copyright Copyright © 2005-2008 PradoSoft
+ * @copyright Copyright © 2005-2008 PradoSoft
* @license http://www.pradosoft.com/license/
* @version $Id$
* @package System.Web.UI.ActiveControls
@@ -63,11 +63,11 @@ class TActiveButton extends TButton implements ICallbackEventHandler, IActiveCon
}
/**
- * Raises the callback event. This method is required by {@link
- * ICallbackEventHandler} interface. If {@link getCausesValidation
- * CausesValidation} is true, it will invoke the page's {@link TPage::
- * validate validate} method first. It will raise {@link onClick
- * OnClick} event first and then the {@link onCallback OnCallback} event.
+ * Raises the callback event. This method is required by
+ * {@link ICallbackEventHandler} interface. If {@link getCausesValidation CausesValidation}
+ * is true, it will invoke the page's {@link TPage::validate validate}
+ * method first. It will raise {@link onClick OnClick} event first
+ * and then the {@link onCallback OnCallback} event.
* This method is mainly used by framework and control developers.
* @param TCallbackEventParameter the event parameter
*/
diff --git a/framework/Web/UI/ActiveControls/TActiveControlAdapter.php b/framework/Web/UI/ActiveControls/TActiveControlAdapter.php
index 8c6ba430..a595e823 100644
--- a/framework/Web/UI/ActiveControls/TActiveControlAdapter.php
+++ b/framework/Web/UI/ActiveControls/TActiveControlAdapter.php
@@ -262,7 +262,7 @@ class TCallbackPageStateTracker
}
/**
- * @array list of viewstate and the changed data.
+ * @return array list of viewstate and the changed data.
*/
protected function getChanges()
{
diff --git a/framework/Web/UI/ActiveControls/TActiveFileUpload.php b/framework/Web/UI/ActiveControls/TActiveFileUpload.php
index b935936b..8237df67 100755
--- a/framework/Web/UI/ActiveControls/TActiveFileUpload.php
+++ b/framework/Web/UI/ActiveControls/TActiveFileUpload.php
@@ -5,6 +5,7 @@
* @author Bradley Booms <Bradley.Booms@nsighttel.com>
* @author Christophe Boulain <Christophe.Boulain@gmail.com>
* @version $Id$
+ * @package System.Web.UI.ActiveControls
*/
/**
@@ -37,7 +38,7 @@ Prado::using('System.Web.UI.WebControls.TFileUpload');
*
* @author Bradley Booms <Bradley.Booms@nsighttel.com>
* @author Christophe Boulain <Christophe.Boulain@gmail.com>
- *
+ * @package System.Web.UI.ActiveControls
* @version $Id$
*/
class TActiveFileUpload extends TFileUpload implements IActiveControl, ICallbackEventHandler, INamingContainer
diff --git a/framework/Web/UI/ActiveControls/TActiveImageButton.php b/framework/Web/UI/ActiveControls/TActiveImageButton.php
index ee16c0d0..f8cd6e12 100644
--- a/framework/Web/UI/ActiveControls/TActiveImageButton.php
+++ b/framework/Web/UI/ActiveControls/TActiveImageButton.php
@@ -100,11 +100,11 @@ class TActiveImageButton extends TImageButton implements IActiveControl, ICallba
}
/**
- * Raises the callback event. This method is required by {@link
- * ICallbackEventHandler} interface. If {@link getCausesValidation
- * CausesValidation} is true, it will invoke the page's {@link TPage::
- * validate validate} method first. It will raise {@link onClick
- * OnClick} event first and then the {@link onCallback OnCallback} event.
+ * Raises the callback event. This method is required by
+ * {@link ICallbackEventHandler ICallbackEventHandler} interface. If
+ * {@link getCausesValidation CausesValidation} is true, it will invoke the page's
+ * {@link TPage::validate} method first. It will raise
+ * {@link onClick OnClick} event first and then the {@link onCallback OnCallback} event.
* This method is mainly used by framework and control developers.
* @param TCallbackEventParameter the event parameter
*/
diff --git a/framework/Web/UI/ActiveControls/TActiveLinkButton.php b/framework/Web/UI/ActiveControls/TActiveLinkButton.php
index f1551b40..e784c270 100644
--- a/framework/Web/UI/ActiveControls/TActiveLinkButton.php
+++ b/framework/Web/UI/ActiveControls/TActiveLinkButton.php
@@ -63,11 +63,12 @@ class TActiveLinkButton extends TLinkButton implements IActiveControl, ICallback
}
/**
- * Raises the callback event. This method is required by {@link
- * ICallbackEventHandler} interface. If {@link getCausesValidation
- * CausesValidation} is true, it will invoke the page's {@link TPage::
- * validate validate} method first. It will raise {@link onClick
- * OnClick} event first and then the {@link onCallback OnCallback} event.
+ * Raises the callback event. This method is required by
+ * {@link ICallbackEventHandlerICallbackEventHandler} interface. If
+ * {@link getCausesValidation CausesValidation} is true, it will
+ * invoke the page's {@link TPage::validate validate} method first. It will raise
+ * {@link onClick OnClick} event first and then the {@link onCallback OnCallback}
+ * event.
* This method is mainly used by framework and control developers.
* @param TCallbackEventParameter the event parameter
*/
diff --git a/framework/Web/UI/ActiveControls/TAutoComplete.php b/framework/Web/UI/ActiveControls/TAutoComplete.php
index 13200e51..2ae01d2b 100644
--- a/framework/Web/UI/ActiveControls/TAutoComplete.php
+++ b/framework/Web/UI/ActiveControls/TAutoComplete.php
@@ -392,7 +392,7 @@ class TAutoCompleteEventParameter extends TCallbackEventParameter
}
/**
- * @int selected suggestion zero-based index, -1 if not selected.
+ * @return int selected suggestion zero-based index, -1 if not selected.
*/
public function getSelectedIndex()
{
diff --git a/framework/Web/UI/ActiveControls/TBaseActiveControl.php b/framework/Web/UI/ActiveControls/TBaseActiveControl.php
index f301f2c3..92dd3194 100644
--- a/framework/Web/UI/ActiveControls/TBaseActiveControl.php
+++ b/framework/Web/UI/ActiveControls/TBaseActiveControl.php
@@ -30,11 +30,11 @@ Prado::using('System.Web.UI.ActiveControls.TCallbackClientSide');
class TBaseActiveControl extends TComponent
{
/**
- * @TMap map of active control options.
+ * @var TMap map of active control options.
*/
private $_options;
/**
- * @TControl attached control.
+ * @var TControl attached control.
*/
private $_control;
diff --git a/framework/Web/UI/ActiveControls/TCallback.php b/framework/Web/UI/ActiveControls/TCallback.php
index c1559c1f..7eba46db 100644
--- a/framework/Web/UI/ActiveControls/TCallback.php
+++ b/framework/Web/UI/ActiveControls/TCallback.php
@@ -4,7 +4,7 @@
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @link http://www.pradosoft.com/
- * @copyright Copyright © 2005-2008 PradoSoft
+ * @copyright Copyright © 2005-2008 PradoSoft
* @license http://www.pradosoft.com/license/
* @version $Id$
* @package System.Web.UI.ActiveControls
@@ -71,12 +71,12 @@ class TCallback extends TControl implements ICallbackEventHandler, IActiveContro
}
/**
- * Raises the callback event. This method is required by {@link
- * ICallbackEventHandler} interface. If {@link getCausesValidation
- * ActiveControl.CausesValidation} is true, it will invoke the page's {@link TPage::
- * validate validate} method first. It will raise {@link onCallback
- * OnCallback} event. This method is mainly used by framework and control
- * developers.
+ * Raises the callback event. This method is required by
+ * {@link ICallbackEventHandler ICallbackEventHandler} interface. If
+ * {@link getCausesValidation ActiveControl.CausesValidation} is true,
+ * it will invoke the page's {@link TPage::validate validate} method first.
+ * It will raise {@link onCallback OnCallback} event. This method is mainly
+ * used by framework and control developers.
* @param TCallbackEventParameter the event parameter
*/
public function raiseCallbackEvent($param)
diff --git a/framework/Web/UI/ActiveControls/TCallbackClientScript.php b/framework/Web/UI/ActiveControls/TCallbackClientScript.php
index 062f63dc..8fbdd864 100644
--- a/framework/Web/UI/ActiveControls/TCallbackClientScript.php
+++ b/framework/Web/UI/ActiveControls/TCallbackClientScript.php
@@ -126,8 +126,8 @@ class TCallbackClientScript extends TApplicationComponent
}
/**
- * Client script to click on an element. <b>This client-side function
- * is unpredictable.</b>
+ * Client script to click on an element. <b>This client-side function is unpredictable.</b>
+ *
* @param TControl control element or element id
*/
public function click($control)
diff --git a/framework/Web/UI/ActiveControls/TCallbackResponseAdapter.php b/framework/Web/UI/ActiveControls/TCallbackResponseAdapter.php
index 0f2f4ba3..6425b123 100755
--- a/framework/Web/UI/ActiveControls/TCallbackResponseAdapter.php
+++ b/framework/Web/UI/ActiveControls/TCallbackResponseAdapter.php
@@ -29,11 +29,11 @@
class TCallbackResponseAdapter extends THttpResponseAdapter
{
/**
- * @TCallbackResponseWriter[] list of writers.
+ * @var TCallbackResponseWriter[] list of writers.
*/
private $_writers=array();
/**
- * @mixed callback response data.
+ * @var mixed callback response data.
*/
private $_data;
diff --git a/framework/Web/UI/ActiveControls/TDraggable.php b/framework/Web/UI/ActiveControls/TDraggable.php
index e4e4c4c4..2d974786 100755
--- a/framework/Web/UI/ActiveControls/TDraggable.php
+++ b/framework/Web/UI/ActiveControls/TDraggable.php
@@ -5,6 +5,7 @@
* @author Christophe BOULAIN (Christophe.Boulain@gmail.com)
* @copyright Copyright © 2008, PradoSoft
* @license http://www.pradosoft.com/license
+ * @package System.Web.UI.ActiveControls
* @version $Id$
*/
@@ -16,6 +17,7 @@
* @author Christophe BOULAIN (Christophe.Boulain@gmail.com)
* @copyright Copyright © 2008, PradoSoft
* @license http://www.pradosoft.com/license
+ * @package System.Web.UI.ActiveControls
* @version $Id$
*/
class TDraggable extends TPanel
diff --git a/framework/Web/UI/ActiveControls/TDropContainer.php b/framework/Web/UI/ActiveControls/TDropContainer.php
index d109c981..45d08c2f 100755
--- a/framework/Web/UI/ActiveControls/TDropContainer.php
+++ b/framework/Web/UI/ActiveControls/TDropContainer.php
@@ -6,6 +6,7 @@
* @copyright Copyright © 2008, PradoSoft
* @license http://www.pradosoft.com/license
* @version $Id$
+ * @package System.Web.UI.ActiveControls
*/
/**
@@ -30,12 +31,13 @@ Prado::using('System.Web.UI.ActiveControls.TActivePanel');
*
* Events:
*
- * <b>{@link OnDrop OnDrop} : raised when a TDraggable control is dropped. The dropped control is encapsulated in the event parameter
+ * <b>{@link OnDrop OnDrop}</b> : raised when a TDraggable control is dropped. The dropped control is encapsulated in the event parameter
*
* @author Christophe BOULAIN (Christophe.Boulain@gmail.com)
* @copyright Copyright © 2008, PradoSoft
* @license http://www.pradosoft.com/license
* @version $Id$
+ * @package System.Web.UI.ActiveControls
*/
class TDropContainer extends TPanel implements IActiveControl, ICallbackEventHandler
{
@@ -248,6 +250,7 @@ class TDropContainer extends TPanel implements IActiveControl, ICallbackEventHan
* @copyright Copyright © 2008, PradoSoft
* @license http://www.pradosoft.com/license
* @version $Id$
+ * @package System.Web.UI.ActiveControls
*/
class TDropContainerEventParameter extends TEventParameter
{
diff --git a/framework/Web/UI/WebControls/TKeyboard.php b/framework/Web/UI/WebControls/TKeyboard.php
index 9c26fab8..a33a9560 100644
--- a/framework/Web/UI/WebControls/TKeyboard.php
+++ b/framework/Web/UI/WebControls/TKeyboard.php
@@ -4,7 +4,7 @@
*
* @author Sergey Morkovkin <sergeymorkovkin@mail.ru> and Qiang Xue <qiang.xue@gmail.com>
* @link http://www.pradosoft.com/
- * @copyright Copyright © 2005-2008 PradoSoft
+ * @copyright Copyright © 2005-2008 PradoSoft
* @license http://www.pradosoft.com/license/
* @version $Id$
* @package System.Web.UI.WebControls
@@ -34,6 +34,7 @@
*
* @author Sergey Morkovkin <sergeymorkovkin@mail.ru> and Qiang Xue <qiang.xue@gmail.com>
* @version $Id$
+ * @package System.Web.UI.WebControls
* @since 3.1.1
*/
class TKeyboard extends TWebControl
diff --git a/framework/Web/UI/WebControls/TTabPanel.php b/framework/Web/UI/WebControls/TTabPanel.php
index 5deced79..63710e56 100644
--- a/framework/Web/UI/WebControls/TTabPanel.php
+++ b/framework/Web/UI/WebControls/TTabPanel.php
@@ -52,6 +52,7 @@
*
* @author Tomasz Wolny <tomasz.wolny@polecam.to.pl> and Qiang Xue <qiang.xue@gmail.com>
* @version $Id$
+ * @package System.Web.UI.WebControls
* @since 3.1.1
*/
class TTabPanel extends TWebControl implements IPostBackDataHandler
@@ -507,6 +508,7 @@ class TTabPanel extends TWebControl implements IPostBackDataHandler
*
* @author Tomasz Wolny <tomasz.wolny@polecam.to.pl> and Qiang Xue <qiang.xue@gmail.com>
* @version $Id$
+ * @package System.Web.UI.WebControls
* @since 3.1.1
*/
class TTabView extends TWebControl
@@ -660,6 +662,7 @@ class TTabView extends TWebControl
*
* @author Tomasz Wolny <tomasz.wolny@polecam.to.pl> and Qiang Xue <qiang.xue@gmail.com>
* @version $Id$
+ * @package System.Web.UI.WebControls
* @since 3.1.1
*/
class TTabViewCollection extends TControlCollection
--
cgit v1.2.3