Added documentations that goes to the method summary table...

framework/base/CErrorHandler.php

@@ -241,6 +241,7 @@ protected function handleError($event)
 	}
 
 	/**
+	 * whether the current request is an AJAX (XMLHttpRequest) request.
 	 * @return boolean whether the current request is an AJAX request.
 	 */
 	protected function isAjaxRequest()
@@ -249,6 +250,7 @@ protected function isAjaxRequest()
 	}
 
 	/**
+	 * Returns the exact trace where the problem occurs.
 	 * @param Exception $exception the uncaught exception
 	 * @return array the exact trace where the problem occurs
 	 */
@@ -333,7 +335,9 @@ protected function getViewFileInternal($viewPath,$view,$code,$srcLanguage=null)
 	}
 
 	/**
-	 * @return string server version information. If the application is in production mode, nothing is returned.
+	 * Returns server version information.
+	 * If the application is in production mode, empty string is returned.
+	 * @return string server version information. Empty if in production mode.
 	 */
 	protected function getVersionInfo()
 	{
@@ -351,8 +355,8 @@ protected function getVersionInfo()
 	/**
 	 * Converts arguments array to its string representation
 	 *
-	 * @param array $args
-	 * @return string
+	 * @param array $args arguments array to be converted
+	 * @return string string representation of the arguments array
 	 */
 	protected function argumentsToString($args)
 	{

framework/collections/CList.php

@@ -98,6 +98,7 @@ public function count()
 	}
 
 	/**
+	 * Returns the number of items in the list.
 	 * @return integer the number of items in the list
 	 */
 	public function getCount()

framework/collections/CMap.php

@@ -90,6 +90,7 @@ public function count()
 	}
 
 	/**
+	 * Returns the number of items in the map.
 	 * @return integer the number of items in the map
 	 */
 	public function getCount()

framework/collections/CQueue.php

@@ -149,6 +149,7 @@ public function getIterator()
 	}
 
 	/**
+	 * Returns the number of items in the queue.
 	 * @return integer the number of items in the queue
 	 */
 	public function getCount()

framework/collections/CStack.php

@@ -150,6 +150,7 @@ public function getIterator()
 	}
 
 	/**
+	 * Returns the number of items in the stack.
 	 * @return integer the number of items in the stack
 	 */
 	public function getCount()

framework/web/CHttpRequest.php

@@ -159,13 +159,14 @@ public function getPost($name,$defaultValue=null)
 	}
 
 	/**
-	 * @return string part of the request URL after the host info.
+	 * Returns part of the request URL after the host info.
 	 * It consists of the following parts:
 	 * <ul>
 	 * <li>{@link getScriptUrl scriptUrl}</li>
 	 * <li>{@link getPathInfo pathInfo}</li>
 	 * <li>{@link getQueryString queryString}</li>
 	 * </ul>
+	 * @return string part of the request URL after the host info.
 	 */
 	public function getUrl()
 	{
@@ -385,6 +386,7 @@ public function getRequestUri()
 	}
 
 	/**
+	 * Returns part of the request URL that is after the question mark.
 	 * @return string part of the request URL that is after the question mark
 	 */
 	public function getQueryString()
@@ -393,6 +395,7 @@ public function getQueryString()
 	}
 
 	/**
+	 * Return if the request is sent via secure channel (https).
 	 * @return boolean if the request is sent via secure channel (https)
 	 */
 	public function getIsSecureConnection()
@@ -401,6 +404,7 @@ public function getIsSecureConnection()
 	}
 
 	/**
+	 * Returns the request type, such as GET, POST, HEAD, PUT, DELETE.
 	 * @return string request type, such as GET, POST, HEAD, PUT, DELETE.
 	 */
 	public function getRequestType()
@@ -409,14 +413,16 @@ public function getRequestType()
 	}
 
 	/**
-	 * @return boolean whether this is POST request.
+	 * Returns whether this is an POST request.
+	 * @return boolean whether this is an POST request.
 	 */
 	public function getIsPostRequest()
 	{
 		return isset($_SERVER['REQUEST_METHOD']) && !strcasecmp($_SERVER['REQUEST_METHOD'],'POST');
 	}
 
 	/**
+	 * Returns whether this is an AJAX (XMLHttpRequest) request.
 	 * @return boolean whether this is an AJAX (XMLHttpRequest) request.
 	 */
 	public function getIsAjaxRequest()
@@ -425,6 +431,7 @@ public function getIsAjaxRequest()
 	}
 
 	/**
+	 * Returns the server name.
 	 * @return string server name
 	 */
 	public function getServerName()
@@ -433,6 +440,7 @@ public function getServerName()
 	}
 
 	/**
+	 * Returns the server port number.
 	 * @return integer server port number
 	 */
 	public function getServerPort()
@@ -441,6 +449,7 @@ public function getServerPort()
 	}
 
 	/**
+	 * Returns the URL referrer, null if not present
 	 * @return string URL referrer, null if not present
 	 */
 	public function getUrlReferrer()
@@ -449,6 +458,7 @@ public function getUrlReferrer()
 	}
 
 	/**
+	 * Returns the user agent, null if not present.
 	 * @return string user agent, null if not present
 	 */
 	public function getUserAgent()
@@ -457,6 +467,7 @@ public function getUserAgent()
 	}
 
 	/**
+	 * Returns the user IP address.
 	 * @return string user IP address
 	 */
 	public function getUserHostAddress()
@@ -465,6 +476,7 @@ public function getUserHostAddress()
 	}
 
 	/**
+	 * Returns the user host name, null if it cannot be determined.
 	 * @return string user host name, null if cannot be determined
 	 */
 	public function getUserHost()
@@ -473,6 +485,7 @@ public function getUserHost()
 	}
 
 	/**
+	 * Returns entry script file path.
 	 * @return string entry script file path (processed w/ realpath())
 	 */
 	public function getScriptFile()
@@ -496,6 +509,7 @@ public function getBrowser($userAgent=null)
 	}
 
 	/**
+	 * Returns user browser accept types, null if not present.
 	 * @return string user browser accept types, null if not present
 	 */
 	public function getAcceptTypes()
@@ -598,9 +612,10 @@ public function redirect($url,$terminate=true,$statusCode=302)
 	}
 
 	/**
-	 * @return string the user preferred language.
+	 * Returns the user preferred language.
 	 * The returned language ID will be canonicalized using {@link CLocale::getCanonicalID}.
 	 * This method returns false if the user does not have language preference.
+	 * @return string the user preferred language.
 	 */
 	public function getPreferredLanguage()
 	{

framework/web/CHttpSession.php

@@ -386,6 +386,7 @@ public function getIterator()
 	}
 
 	/**
+	 * Returns the number of items in the session.
 	 * @return integer the number of session variables
 	 */
 	public function getCount()