adamjakab / SuiteCRM

include/Localization/Localization.php

Doc Comments +1 added lines

@@ -122,6 +122,7 @@
 	 * abstraction of precedence
 	 * @param string prefName Name of preference to retrieve based on overrides
 	 * @param object user User in focus, default null (current_user)
+	 * @param string $prefName
 	 * @return string pref Most significant preference
 	 */
 	function getPrecedentPreference($prefName, $user=null, $sugarConfigPrefName = '') {

include/MassUpdate.php

Doc Comments +6 added lines

@@ -1151,6 +1151,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @param string $value
+	 */
 	function date_to_dateTime($field, $value) {
 		global $timedate;
 	    //Check if none was set
@@ -1180,6 +1183,9 @@ 
 	    return $value." ".$oldTime;
 	}
 
+	/**
+	 * @param string $value
+	 */
 	function checkClearField($field, $value) {
 	    if ($value == 1 && strpos($field, '_flag')) {
 	        $fName = substr($field, -5);

include/MVC/Controller/SugarController.php

Doc Comments +4 added lines, -1 removed lines

@@ -244,6 +244,7 @@ 
 
 	/**
 	 * Generic load method to load mapping arrays.
+	 * @param string $var
 	 */
 	private function loadMapping($var, $merge = false){
 		$$var = sugar_cache_retrieve("CONTROLLER_". $var . "_".$this->module);
@@ -469,7 +470,8 @@ 
 	/**
 	 * Determine if a given function exists on the objects
 	 * @param function - the function to check
-	 * @return true if the method exists on the object, false otherwise
+	 * @param string $function
+	 * @return boolean if the method exists on the object, false otherwise
 	 */
 	protected function hasFunction($function){
 		return method_exists($this, $function);
@@ -777,6 +779,7 @@ 
 
 	/**
 	 * getActionFilename
+	 * @param string $action
 	 */
 	public static function getActionFilename($action) {
 	   if(isset(self::$action_case_file[$action])) {

include/MVC/SugarApplication.php

Doc Comments +2 added lines, -1 removed lines

@@ -668,7 +668,6 @@ 
 	 * Redirect to another URL
 	 *
 	 * @access	public
-	 * @param	string	$url	The URL to redirect to
 	 */
  	public static function appendErrorMessage($error_message)
 	{
@@ -692,6 +691,8 @@ 
 	/**
 	 * Wrapper for the PHP setcookie() function, to handle cases where headers have
 	 * already been sent
+	 * @param string $name
+	 * @param string $domain
 	 */
 	public static function setCookie(
 	    $name,

include/MVC/View/SugarView.php

Doc Comments +6 added lines, -2 removed lines

@@ -1039,6 +1039,7 @@ 
      *
      * @param string option - the option that we want to know the valye of
      * @param bool default - what the default value should be if we do not find the option
+     * @param string $option
      *
      * @return bool - the value of the option
      */
@@ -1273,7 +1274,7 @@ 
     * Return the "breadcrumbs" to display at the top of the page
     *
     * @param  bool $show_help optional, true if we show the help links
-    * @return HTML string containing breadcrumb title
+    * @return string string containing breadcrumb title
     */
     public function getModuleTitle(
         $show_help = true
@@ -1446,6 +1447,9 @@ 
     	}
     }
 
+    /**
+     * @param string $module
+     */
     protected function getModuleTitleIconPath($module)
     {
     	$iconPath = "";
@@ -1496,7 +1500,7 @@ 
     /**
      * Fetch config values to be put into an array for JavaScript
      *
-     * @return array
+     * @return string[]
      */
     protected function getSugarConfigJS(){
         global $sugar_config;

include/MVC/View/ViewFactory.php

Doc Comments +5 added lines

@@ -53,6 +53,7 @@ 
 	/**
 	 * load the correct view
 	 * @param string $type View Type
+	 * @param string $module
 	 * @return valid view
 	 */
 	static function loadView($type = 'default', $module, $bean = null, $view_object_map = array(), $target_module=''){
@@ -98,6 +99,7 @@ 
 
 	/**
 	 * Load the view_<view>_config.php file which holds options used by the view.
+	 * @param string $type
 	 */
 	static function _loadConfig(&$view, $type){
 		$view_config_custom = array();
@@ -199,6 +201,8 @@ 
 	 * This is a private function which just helps the getView function generate the
 	 * proper view object
 	 *
+	 * @param string $file
+	 * @param string $type
 	 * @return a valid SugarView
 	 */
 	static function _buildFromFile($file, &$bean, $view_object_map, $type, $module){
@@ -242,6 +246,7 @@ 
 	 * @param object bean = the bean to pass to the view
 	 * @param array view_object_map - the array which holds obejcts to pass between the
 	 *                                controller and the view.
+	 * @param string $class
 	 *
 	 * @return SugarView
 	 */

include/MVC/View/views/view.list.php

Doc Comments +1 added lines

@@ -272,6 +272,7 @@
 
       /**
        *
+       * @param string $module
        * @return SearchForm
        */
     protected function getSearchForm2($seed, $module, $action = "index")

include/MVC/View/views/view.metadata.php

Doc Comments +7 added lines

@@ -47,6 +47,9 @@ 
 	
 	
  	
+ 	/**
+ 	 * @param string $name
+ 	 */
  	function displayCheckBoxes($name,$values, $selected =array(), $attr=''){
  		echo "<div $attr style='overflow:auto;float:left;width:200px;height:200px' >";
 		foreach($values as $value){
@@ -56,6 +59,10 @@ 
 		echo "</div>";
  	}
  	
+ 	/**
+ 	 * @param string $name
+ 	 * @param string[] $values
+ 	 */
  	function displaySelect($name,$values, $selected ='', $attr=''){
  		echo "<select name='$name' $attr>";
 		foreach($values as $value){

include/nusoap/class.nusoap_base.php

Doc Comments +7 added lines, -7 removed lines

@@ -356,7 +356,7 @@ 
 	/**
 	* gets the current debug data for this instance
 	*
-	* @return   debug data
+	* @return   string data
 	* @access   public
 	*/
 	function &getDebug() {
@@ -369,7 +369,7 @@ 
 	* gets the current debug data for this instance as an XML comment
 	* this may change the contents of the debug data
 	*
-	* @return   debug data as an XML comment
+	* @return   string data as an XML comment
 	* @access   public
 	*/
 	function &getDebugAsXMLComment() {
@@ -402,7 +402,7 @@ 
 	/**
 	* returns error string if present
 	*
-	* @return   mixed error string or false
+	* @return   string|false error string or false
 	* @access   public
 	*/
 	function getError(){
@@ -415,7 +415,7 @@ 
 	/**
 	* sets error string
 	*
-	* @return   boolean $string error string
+	* @return   boolean|null $string error string
 	* @access   private
 	*/
 	function setError($str){
@@ -851,7 +851,7 @@ 
     * returns false, if not prefixed
     *
     * @param string $str The prefixed string
-    * @return mixed The prefix or false if there is no prefix
+    * @return string|false The prefix or false if there is no prefix
     * @access public
     */
 	function getPrefix($str){
@@ -882,7 +882,7 @@ 
     * or false if no prefixes registered for the given namespace
     *
     * @param string $ns The namespace
-    * @return mixed The prefix, false if the namespace has no prefixes
+    * @return string The prefix, false if the namespace has no prefixes
     * @access public
     */
 	function getPrefixFromNamespace($ns) {
@@ -948,7 +948,7 @@ 
 *
 * @param    int $timestamp Unix time stamp
 * @param	boolean $utc Whether the time stamp is UTC or local
-* @return	mixed ISO 8601 date string or false
+* @return	string|false ISO 8601 date string or false
 * @access   public
 */
 function timestamp_to_iso8601($timestamp,$utc=true){