adamjakab / SuiteCRM

modules/Schedulers/Scheduler.php

Doc Comments +6 added lines, -1 removed lines

@@ -203,7 +203,7 @@ 
 	 * qualified by its ranges.  The times are from the time of calling the
 	 * script.
 	 *
-	 * @param	$focus		Scheduler object
+	 * @param	Scheduler $focus		Scheduler object
 	 * @return	$dateTimes	array loaded with DB datetime strings derived from
 	 * 						the	 job_interval attribute
 	 * @return	false		If we the Scheduler is not in scope, return false.
@@ -555,6 +555,11 @@ 
 		return $validJobTime;
 	}
 
+	/**
+	 * @param integer $type
+	 * @param string $mins
+	 * @param string $hours
+	 */
 	function handleIntervalType($type, $value, $mins, $hours) {
 		global $mod_strings;
 		/* [0]:min [1]:hour [2]:day of month [3]:month [4]:day of week */

modules/SchedulersJobs/SchedulersJob.php

Doc Comments +3 added lines

@@ -356,6 +356,7 @@ 
     /**
      * Delete a job
      * @see SugarBean::mark_deleted($id)
+     * @param string $id
      */
     public function mark_deleted($id)
     {
@@ -595,12 +596,14 @@ 
     /**
      * @abstract
      * @param SchedulersJob $job
+     * @return void
      */
     public function setJob(SchedulersJob $job);
 
     /**
      * @abstract
      *
+     * @return boolean
      */
     public function run($data);
 }

modules/SecurityGroups/SecurityGroup.php

Doc Comments +4 added lines

@@ -168,6 +168,10 @@
         return false;
     }
 
+    /**
+     * @param SugarBean $focus
+     * @param boolean $isUpdate
+     */
     static function inherit(&$focus,$isUpdate)
     {
         global $sugar_config;

modules/Studio/DropDowns/DropDownHelper.php

Doc Comments +4 added lines

@@ -54,6 +54,9 @@ 
 
     }
 
+    /**
+     * @param string $filepath
+     */
     function scanForDropDowns($filepath, $module){
         $contents = file_get_contents($filepath);
         $matches = array();
@@ -73,6 +76,7 @@ 
      *
      * @param string name
      * @param array dropdown
+     * @param string $name
      * @return array Filtered dropdown list
      */
     function filterDropDown($name,$dropdown)

modules/Studio/parsers/StudioParser.php

Doc Comments +9 added lines

@@ -434,6 +434,10 @@ 
 		$_REQUEST['advanced'] = true;
 
 	}
+
+	/**
+	 * @param string $cache_file
+	 */
 	function cacheXTPL($file, $cache_file, $preview_file = false) {
 		global $beanList;
 		//now if we have a backup_file lets use that instead of the original
@@ -560,6 +564,8 @@ 
 	 * add:2000
 	 * swap: 0 - 1999
 	 *
+	 * @param integer $slot_count
+	 * @param string $display_count
 	 */
 	function addSlotToForm($slot_count, $display_count){
 		$this->form .= "\n<input type='hidden' name='slot_$slot_count'  id='slot_$display_count' value='$slot_count'>";
@@ -599,6 +605,9 @@ 
 		return $newView;
 	}
 
+	/**
+	 * @param string $file
+	 */
 	function parseOldestFile($file){
 	 ob_clean();
 		require_once('modules/Studio/SugarBackup.php');

modules/SugarFeed/Dashlets/SugarFeedDashlet/SugarFeedDashlet.php

Doc Comments +5 added lines, -2 removed lines

@@ -463,7 +463,7 @@ 
 
 	/**
 	 *
-	 * @return the fully rendered dashlet
+	 * @return string fully rendered dashlet
 	 */
 	function display(){
 
@@ -499,7 +499,7 @@ 
 
 	/**
 	 *
-	 * @return the title and the user post form
+	 * @return string title and the user post form
 	 * @param $text Object
 	 */
 	function getHeader($text='') {
@@ -579,6 +579,9 @@ 
         }
     }
 
+    /**
+     * @param string $type
+     */
     function check_enabled($type){
         global $db;
         $query = "SELECT * FROM config where name = 'module_" .$type . "' and value =  1;";

modules/SugarFeed/SugarFeed.php

Doc Comments +1 added lines, -1 removed lines

@@ -220,7 +220,7 @@
      * pushFeed2
      * This method is a wrapper to pushFeed
      *
-     * @param $text String value of the feed's description
+     * @param string $text String value of the feed's description
      * @param $bean The SugarBean that is triggering the feed
      * @param $link_type boolean value indicating whether or not feed is a link type
      * @param $link_url String value of the URL (for link types only)

modules/Tasks/Task.php

Doc Comments +3 added lines

@@ -236,6 +236,9 @@
 	}
 
 
+    /**
+     * @param boolean $override_date_for_subpanel
+     */
     protected function formatStartAndDueDates(&$task_fields, $dbtime, $override_date_for_subpanel)
     {
         global $timedate;

modules/Trackers/BreadCrumbStack.php

Doc Comments +1 added lines, -1 removed lines

@@ -103,7 +103,7 @@
     * Returns true if the stack contains the specified item_id, false otherwise.
     * 
     * @param item_id the item id to search for
-    * @return id of the first item on the stack
+    * @return boolean of the first item on the stack
     */
    public function contains($item_id) {
    	  	if(!empty($this->stackMap)){