adamjakab / SuiteCRM

include/connectors/utils/ConnectorUtils.php

Doc Comments -1 removed lines

@@ -417,7 +417,6 @@
      * getModuleConnectors
      *
      * @param String $module the module to get the connectors for
-     * @param mixed $connectors Array of connectors mapped to the module or empty if none
      * @return array
      */
     public static function getModuleConnectors(

include/controller/Controller.php

Doc Comments +6 added lines

@@ -232,6 +232,9 @@ 
 	//end function update_affected_order
 	}
 	
+	/**
+	 * @param string $parent_id
+	 */
 	function get_affected_id($parent_id, $list_order_x="", $list_order_y=""){	
 		
 		$query = "	SELECT id from ".$this->focus->table_name."
@@ -260,6 +263,9 @@ 
 /////////////Wall Functions////////////////////
 
 
+/**
+ * @param string $parent_id
+ */
 function check_wall($magnitude, $direction, $parent_id){
 	
 //TODO: jgreen - this is only single axis check_wall mechanism, will need to upgrade this to double axis	

include/Dashlets/DashletGenericChart.php

Doc Comments +6 added lines

@@ -364,6 +364,10 @@ 
     }
 
     //Added as the rgraph charts do not use SugarCharts and this is where this method was previously
+
+    /**
+     * @param string $query
+     */
     function getChartData($query)
     {
         global $app_list_strings, $db;
@@ -390,6 +394,8 @@ 
     string $keycolname1      We will sort by this key secondly, and  it can be null, then it will only sort by the first column.
     bool $translate1            Whether to trabslate the second column
     bool $ifsort2                 Whether to sort by the second column or just translate the second column.
+    * @param string $keycolname1
+    * @param string $keycolname2
      * @return        The sorted and translated data.
      */
     function sortData($data_set, $keycolname1=null, $translate1=false, $keycolname2=null, $translate2=false, $ifsort2=false) {

include/database/DBManager.php

Doc Comments +7 added lines, -7 removed lines

@@ -354,7 +354,7 @@ 
 
 	/**
 	 * Return DB error message for the last query executed
-	 * @return string Last error message
+	 * @return boolean Last error message
 	 */
 	public function lastError()
 	{
@@ -1580,7 +1580,7 @@ 
     /**
      * Frees out previous results
      *
-     * @param resource|bool $result optional, pass if you want to free a single result instead of all results
+     * @param boolean $result optional, pass if you want to free a single result instead of all results
      */
 	protected function freeResult($result = false)
 	{
@@ -2697,7 +2697,7 @@ 
      * @param bool|string $ensureUnique Ensure the name is unique
      * @param string $type Name type (table, column)
      * @param bool $force Force new name
-     * @return string|array Valid column name trimmed to right length and with invalid characters removed
+     * @return string Valid column name trimmed to right length and with invalid characters removed
      */
 	public function getValidDBName($name, $ensureUnique = false, $type = 'column', $force = false)
 	{
@@ -3158,7 +3158,7 @@ 
 	 * @param int $count
 	 * @param bool $dieOnError
 	 * @param string $msg
-     * @return resource|bool query result
+     * @return resource query result
      * @see DBManager::limitQuery()
 	 */
 	public function limitQuerySql($sql, $start, $count, $dieOnError=false, $msg='')
@@ -3385,7 +3385,7 @@ 
 	 * @param bool $dieOnError Die on error, passed to query()
 	 * @param string $msg Error message, passed to query()
 	 * @param bool $suppress Supress errors, passed to query()
-	 * @return resource|bool result set or success/failure bool
+	 * @return boolean result set or success/failure bool
 	 */
 	public function queryArray(array $sqls, $dieOnError = false, $msg = '', $suppress = false)
 	{
@@ -3508,7 +3508,7 @@ 
 	 * @abstract
 	 * If everything is OK, return true.
 	 * If something's wrong, return array of error code and parameters
-	 * @return mixed
+	 * @return boolean
 	 */
 	public function canInstall()
 	{
@@ -3773,7 +3773,7 @@ 
 	 * @param array  $fieldDefs
 	 * @param string $action
 	 * @param bool   $ignoreRequired Optional, true if we should ignor this being a required field
-	 * @return string|array
+	 * @return string
 	 */
 	abstract protected function changeColumnSQL($tablename, $fieldDefs, $action, $ignoreRequired = false);
 

include/database/MssqlManager.php

Doc Comments +4 added lines, -4 removed lines

@@ -1298,7 +1298,7 @@ 
      * modify operation
      * @param string $action
      * @param array  $def
-     * @param bool   $ignorRequired
+     * @param boolean   $ignoreRequired
      * @param string $tablename
      */
     protected function alterSQLRep($action, array $def, $ignoreRequired, $tablename)
@@ -1767,7 +1767,7 @@ 
     /**
      * Saves changes to module's audit table
      *
-     * @param object $bean    Sugarbean instance
+     * @param SugarBean $bean    Sugarbean instance
      * @param array  $changes changes
      */
     public function save_audit_records(SugarBean $bean, $changes)
@@ -1876,7 +1876,7 @@ 
      * This is a utility function to prepend the "N" character in front of SQL values that are
      * surrounded by single quotes.
      *
-     * @param  $sql string SQL statement
+     * @param  string $sql string SQL statement
      * @return string SQL statement with single quote values prepended with "N" character for nvarchar columns
      */
     protected function _appendN($sql)
@@ -1947,7 +1947,7 @@ 
 
     /**
      * Generate fulltext query from set of terms
-     * @param string $fields Field to search against
+     * @param string $field Field to search against
      * @param array $terms Search terms that may be or not be in the result
      * @param array $must_terms Search terms that have to be in the result
      * @param array $exclude_terms Search terms that have to be not in the result

include/database/MysqlManager.php

Doc Comments +5 added lines, -2 removed lines

@@ -651,7 +651,7 @@ 
 	/**
 	 * Returns the name of the engine to use or null if we are to use the default
 	 *
-	 * @param  object $bean SugarBean instance
+	 * @param  SugarBean $bean SugarBean instance
 	 * @return string
 	 */
 	protected function getEngine($bean)
@@ -1149,7 +1149,7 @@ 
 
 	/**
 	 * Generate fulltext query from set of terms
-	 * @param string $fields Field to search against
+	 * @param string $field Field to search against
 	 * @param array $terms Search terms that may be or not be in the result
 	 * @param array $must_terms Search terms that have to be in the result
 	 * @param array $exclude_terms Search terms that have to be not in the result
@@ -1276,6 +1276,9 @@ 
 		return '';
 	}
 
+	/**
+	 * @param string $querytype
+	 */
 	protected function verifyGenericReplaceQuery($querytype, $table, $query)
 	{
 		$this->log->debug("verifying $querytype statement");

include/database/SqlsrvManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -540,7 +540,7 @@
 
     /**
      * Execute data manipulation statement, then roll it back
-     * @param  $type
+     * @param  string $type
      * @param  $table
      * @param  $query
      * @return string

include/DetailView/DetailView.php

Doc Comments +4 added lines, -1 removed lines

@@ -237,6 +237,9 @@ 
 		return $object;
 	}
 
+	/**
+	 * @param boolean $isfirstview
+	 */
 	function populateQueryWhere($isfirstview, $html_varName){
 		if($isfirstview){
             $this->query_where = $this->getVariableFromSession($_REQUEST['module'], 'QUERY_WHERE');
@@ -454,7 +457,7 @@ 
      * Return a variable from the session. uses the new ListView session data. Hence the '2'
      *
      * @param unknown_type $name - the name of the variable to set in the session
-     * @param unknown_type $value - the value of the variable to set
+     * @param string $value - the value of the variable to set
      */
     function getVariableFromSession($name, $value){
           if(isset($_SESSION[$name."2_".$value])){

include/DetailView/DetailView2.php

Doc Comments +2 added lines, -2 removed lines

@@ -54,10 +54,10 @@
      * This is the DetailView constructor responsible for processing the new
      * Meta-Data framework
      *
-     * @param $module String value of module this detail view is for
+     * @param string $module String value of module this detail view is for
      * @param $focus An empty sugarbean object of module
      * @param $id The record id to retrieve and populate data for
-     * @param $metadataFile String value of file location to use in overriding default metadata file
+     * @param string $metadataFile String value of file location to use in overriding default metadata file
      * @param tpl String value of file location to use in overriding default Smarty template
      */