adamjakab / SuiteCRM

include/SugarCache/SugarCacheAbstract.php

Doc Comments +2 added lines, -2 removed lines

@@ -158,7 +158,7 @@ 
      *  Set a value for a key in the cache, optionally specify a ttl. A ttl value of zero
      * will indicate that a value should only be stored per the request.
      *
-     * @param $key
+     * @param string $key
      * @param $value
      * @param $ttl
      */
@@ -192,7 +192,7 @@ 
      * PHP's magic __isset() method, used here for checking for a key in the cache.
      *
      * @param  string $key
-     * @return mixed
+     * @return boolean
      */
     public function __isset($key)
     {

include/SugarCharts/Jit/Jit.php

Doc Comments +3 added lines

@@ -68,6 +68,9 @@
 	}
 	
 
+	/**
+	 * @param string $name
+	 */
 	function display($name, $xmlFile, $width='320', $height='480', $resize=false) {
 	
 		parent::display($name, $xmlFile, $width, $height, $resize);

include/SugarCharts/JsChart.php

Doc Comments +6 added lines

@@ -77,6 +77,9 @@ 
 
 	}
 
+	/**
+	 * @param integer $depth
+	 */
 	function tab($str, $depth){
        // $str = preg_replace('/(<\w+>)(.*)(<\/\w+>)/e', "'\\1'.htmlentities(from_html('\\2')).'\\3'", $str);
         return str_repeat("\t", $depth) . $str . "\n";
@@ -663,6 +666,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @param string $jsonContents
+	 */
 	function saveJsonFile($jsonContents) {
 		$this->jsonFilename = str_replace(".xml",".js",$this->xmlFile);
 		//$jsonContents = $GLOBALS['locale']->translateCharset($jsonContents, 'UTF-8', 'UTF-16LE');

include/SugarCharts/SugarChart.php

Doc Comments +7 added lines, -6 removed lines

@@ -292,11 +292,8 @@ 
 	/**
      * returns text with tabs appended before it
 	 *
-     * @param 	string $str xml tag
-     			int $tagFormat 2 = open and close tag, 1 = close, 0 = open
-     			sting $value input string
-	 *			int $depth number of times to tab
      * @return	string with tabs appended before it
+     * @param integer $depth
      */
 
 	function tabValue($tag,$value,$depth) {
@@ -339,6 +336,9 @@ 
 		return $data;
 	}
 
+	/**
+	 * @param integer $tablevel
+	 */
 	function processDataGroup($tablevel, $title, $value, $label, $link){
 		$link = $this->forceHideDataGroupLink ? '' : $link;
 		$data = $this->tab('<group>',$tablevel);
@@ -645,7 +645,7 @@ 
      * This function sets a null group by clause
      *
      * @param $sugarSetValue Mixed value
-     * @param $url String value of URL for the link
+     * @param string $url String value of URL for the link
      */
     private function nullGroup($superSetValue, $url) {
         return $this->processDataGroup(4, $superSetValue, 'NULL', '', $url);
@@ -709,7 +709,8 @@ 
 	 *
      * @param 	string $xmlFilename location of the xml file
 	 *			string $xmlContents contents of the xml file
-     * @return	string boolean denoting whether save has failed
+	 * @param string $xmlContents
+     * @return	null|boolean boolean denoting whether save has failed
      */
 	function saveXMLFile($xmlFilename,$xmlContents) {
 		global $app_strings;

include/SugarEmailAddress/SugarEmailAddress.php

Doc Comments +10 added lines, -16 removed lines

@@ -80,8 +80,6 @@ 
 
     /**
      * Legacy email address handling.  This is to allow support for SOAP or customizations
-     * @param string $id
-     * @param string $module
      */
     function handleLegacySave($bean, $prefix = "") {
         if(!isset($_REQUEST) || !isset($_REQUEST['useEmailWidget'])) {
@@ -166,12 +164,6 @@ 
 
     /**
      * Saves email addresses for a parent bean
-     * @param string $id Parent bean ID
-     * @param string $module Parent bean's module
-     * @param array $addresses Override of $_REQUEST vars, used to handle non-standard bean saves
-     * @param string $primary GUID of primary address
-     * @param string $replyTo GUID of reply-to address
-     * @param string $invalid GUID of invalid address
      */
     public function save($check_notify = FALSE) {
         $args = func_get_args();
@@ -369,7 +361,6 @@ 
      * Saves email addresses for a parent bean
      * @param string $id Parent bean ID
      * @param string $module Parent bean's module
-     * @param array $addresses Override of $_REQUEST vars, used to handle non-standard bean saves
      * @param string $primary GUID of primary address
      * @param string $replyTo GUID of reply-to address
      * @param string $invalid GUID of invalid address
@@ -620,7 +611,7 @@ 
 
     /**
      * preps a passed email address for email address storage
-     * @param array $addr Address in focus, must be RFC compliant
+     * @param string $addr Address in focus, must be RFC compliant
      * @return string $id email_addresses ID
      */
     function getEmailGUID($addr) {
@@ -733,7 +724,8 @@ 
  
     /**
      * Returns Primary or newest email address
-     * @param object $focus Object in focus
+     * @param boolean $focus Object in focus
+     * @param string $parent_type
      * @return string email
      */
     function getPrimaryAddress($focus,$parent_id=null,$parent_type=null) {
@@ -804,7 +796,7 @@ 
      * Returns all email addresses by parent's GUID
      * @param string $id Parent's GUID
      * @param string $module Parent's module
-     * @return array
+     * @return string
      */
     function getAddressesByGUID($id, $module) {
         $return = array();
@@ -828,7 +820,6 @@ 
 
     /**
      * Returns the HTML/JS for the EmailAddress widget
-     * @param string $parent_id ID of parent bean, generally $focus
      * @param string $module $focus' module
      * @param bool asMetadata Default false
      * @return string HTML/JS for widget
@@ -965,7 +956,7 @@ 
 
     /**
      * getEmailAddressWidgetDuplicatesView($focus)
-     * @param object $focus Bean in focus
+     * @param Lead $focus Bean in focus
      * @return string HTML that contains hidden input values based off of HTML request
      */
     function getEmailAddressWidgetDuplicatesView($focus)
@@ -1041,6 +1032,7 @@ 
     /**
      * getFormBaseURL
      *
+     * @param SugarBean $focus
      */
     function getFormBaseURL($focus) {
         $get = "";
@@ -1081,13 +1073,15 @@ 
 
     }
 
+    /**
+     * @param string $view
+     */
     function setView($view) {
        $this->view = $view;
     }
 
 /**
  * This function is here so the Employees/Users division can be handled cleanly in one place
- * @param object $focus SugarBean
  * @return string The value for the bean_module column in the email_addr_bean_rel table
  */
     function getCorrectedModule(&$module) {
@@ -1119,7 +1113,7 @@ 
 
 /**
  * Convenience function for MVC (Mystique)
- * @param object $focus SugarBean
+ * @param SugarBean $focus SugarBean
  * @param string $field unused
  * @param string $value unused
  * @param string $view DetailView or EditView

include/SugarFields/Fields/Base/SugarFieldBase.php

Doc Comments +9 added lines

@@ -114,11 +114,17 @@ 
     }
 
 
+    /**
+     * @return string
+     */
     public function unformatField($formattedField, $vardef){
         // The base field doesn't do any formatting, so override it in subclasses for more specific actions
         return $formattedField;
     }
 
+    /**
+     * @param string $view
+     */
     function getSmartyView($parentFieldArray, $vardef, $displayParams, $tabindex = -1, $view){
     	$this->setup($parentFieldArray, $vardef, $displayParams, $tabindex);
 
@@ -376,6 +382,9 @@ 
 
     }
 
+    /**
+     * @param string $fieldType
+     */
     protected function getAccessKey($vardef, $fieldType = null, $module = null) {
         global $app_strings;
 

include/SugarFields/Fields/Bool/SugarFieldBool.php

Doc Comments +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
 class SugarFieldBool extends SugarFieldBase {
 	/**
 	 *
-	 * @return The html for a drop down if the search field is not 'my_items_only' or a dropdown for all other fields.
+	 * @return string html for a drop down if the search field is not 'my_items_only' or a dropdown for all other fields.
 	 *			This strange behavior arises from the special needs of PM. They want the my items to be checkboxes and all other boolean fields to be dropdowns.
 	 * @author Navjeet Singh
 	 * @param $parentFieldArray -

include/SugarFields/Fields/Collection/ViewSugarFieldCollection.php

Doc Comments +9 added lines

@@ -351,6 +351,10 @@ 
      * Check if the template is cached
      * return a bool
      */
+
+    /**
+     * @param string $cacheRowFile
+     */
     function checkTemplate($cacheRowFile){
         if(inDeveloperMode() || !empty($_SESSION['developerMode'])){
             return false;
@@ -502,6 +506,11 @@ 
 
 
 
+    /**
+     * @param string $view
+     *
+     * @return string
+     */
     function findTemplate($view){
         static $tplCache = array();
 

include/SugarFields/Fields/Currency/SugarFieldCurrency.php

Doc Comments +2 added lines, -3 removed lines

@@ -102,9 +102,8 @@
     /**
      * format the currency field based on system locale values for currency
      * Note that this may be different from the precision specified in the vardefs.
-     * @param string $rawfield value of the field
-     * @param string $somewhere vardef for the field being processed
-     * @return number formatted according to currency settings
+     * @param string $rawField value of the field
+     * @return string formatted according to currency settings
      */
     public function formatField($rawField, $vardef)
     {