adamjakab / SuiteCRM

include/Sugarpdf/SugarpdfHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
 
     /**
      * This function prepare a string to be ready for the PDF printing.
-     * @param $string
+     * @param string $string
      * @return string
      */
     function prepare_string($string){

include/SugarQueue/SugarJobQueue.php

Doc Comments +2 added lines, -3 removed lines

@@ -86,7 +86,6 @@ 
     /**
      * Submit a new job to the queue
      * @param SugarJob $job
-     * @param User $user User to run the job under
      */
     public function submitJob($job)
     {
@@ -105,7 +104,7 @@ 
     /**
      * Get Job object by ID
      * @param string $jobId
-     * @return SugarJob
+     * @return null|SchedulersJob
      */
     protected function getJob($jobId)
     {
@@ -187,7 +186,7 @@ 
     /**
      * Fetch the next job in the queue and mark it running
      * @param string $clientID ID of the client requesting the job
-     * @return SugarJob
+     * @return null|SchedulersJob
      */
     public function nextJob($clientID)
     {

include/SugarTheme/cssmin.php

Doc Comments +2 added lines, -3 removed lines

@@ -34,7 +34,7 @@ 
 	 * </code>
 	 * 
 	 * @param	string			$css		Stylesheet definitions as string
-	 * @param	array|string	$options	Array or comma speperated list of options:
+	 * @param	string	$options	Array or comma speperated list of options:
 	 * 										
 	 * 										- remove-last-semicolon: Removes the last semicolon in 
 	 * 										the style definition of an element (activated by default).
@@ -120,8 +120,7 @@ 
 	 * $css_string = cssmin::toString($css_structure);
 	 * </code>
 	 * 
-	 * @param	array		$css
-	 * @return	array
+	 * @return	string
 	 */
 	public static function toString(array $array)
 		{

include/SugarTheme/SugarSprites.php

Doc Comments +3 added lines

@@ -69,6 +69,9 @@
 		}
 	}
 
+	/**
+	 * @param string $file
+	 */
 	private function loadMetaHelper($dir, $file) {
 		if(file_exists("cache/sprites/{$dir}/{$file}.meta.php")) {
 			$sprites = array();

include/SugarTheme/SugarTheme.php

Doc Comments +4 added lines, -2 removed lines

@@ -458,7 +458,7 @@ 
     /**
      * Return array of all valid fields that can be specified in the themedef.php file
      *
-     * @return array
+     * @return string[]
      */
     public static function getThemeDefFields()
     {
@@ -698,7 +698,7 @@ 
     /**
      * Returns an image tag for the given image.
      *
-     * @param  string $image image name
+     * @param  string $imageName image name
      * @param  string $other_attributes optional, other attributes to add to the image tag, not cached
 	 * @param  string $width optional, defaults to the actual image's width
 	 * @param  string $height optional, defaults to the actual image's height
@@ -817,6 +817,8 @@ 
 	 * @param  string class The md5 id used in the CSS sprites class
 	 * @param  string attr  optional, list of additional html attributes
 	 * @param  string title optional, the title (equivalent to alt on img)
+	 * @param string $attr
+	 * @param string $title
 	 * @return string HTML span tag
 	 */
 	public function getSprite($class, $attr, $title) {

include/SugarXHprof/xhprof_lib/display/xhprof.php

Doc Comments +14 added lines, -2 removed lines

@@ -113,6 +113,7 @@ 
 /**
  * Implodes the text for a bunch of actions (such as links, forms,
  * into a HTML list and returns the text.
+ * @param string[] $actions
  */
 function xhprof_render_actions($actions) {
   $out = array();
@@ -142,8 +143,6 @@ 
  * @param raw-str  $onmouseover
  * @param raw-str  $onmouseout
  * @param raw-str  $onmousedown
- * @param raw-str  $dir
- * @param raw-str  $rel
  */
 function xhprof_render_link($content, $href, $class='', $id='', $title='',
                             $target='',
@@ -589,6 +588,7 @@ 
  * For instance, negative numbers in diff reports comparing two runs (run1 & run2)
  * represent improvement from run1 to run2. We use green to display those deltas,
  * and red for regression deltas.
+ * @param boolean $bold
  */
 function get_print_class($num, $bold) {
   global $vbar;
@@ -712,6 +712,7 @@ 
  * Print non-hierarchical (flat-view) of profiler data.
  *
  * @author Kannan
+ * @param integer $limit
  */
 function print_flat_data($url_params, $title, $flat_data, $sort, $run1, $run2, $limit) {
 
@@ -778,6 +779,7 @@ 
  * Generates a tabular report for all functions. This is the top-level report.
  *
  * @author Kannan
+ * @param integer $run2
  */
 function full_report($url_params, $symbol_tab, $sort, $run1, $run2) {
   global $vwbar;
@@ -922,6 +924,7 @@ 
 
 /**
  * Return attribute names and values to be used by javascript tooltip.
+ * @param string $type
  */
 function get_tooltip_attributes($type, $metric) {
   return "type='$type' metric='$metric'";
@@ -960,6 +963,10 @@ 
   }
 }
 
+/**
+ * @param boolean $parent
+ * @param integer $run2
+ */
 function print_pc_array($url_params, $results, $base_ct, $base_info, $parent,
                         $run1, $run2) {
   global $base_path;
@@ -1299,6 +1306,8 @@ 
  * Generate the profiler report for a single run.
  *
  * @author Kannan
+ * @param string $rep_symbol
+ * @param string $run
  */
 function profiler_single_run_report ($url_params,
                                      $xhprof_data,
@@ -1319,6 +1328,9 @@ 
  * Generate the profiler report for diff mode (delta between two runs).
  *
  * @author Kannan
+ * @param string $rep_symbol
+ * @param string $run1
+ * @param string $run2
  */
 function profiler_diff_report($url_params,
                               $xhprof_data1,

include/SugarXHprof/xhprof_lib/utils/callgraph_utils.php

Doc Comments +4 added lines

@@ -38,6 +38,8 @@ 
  *
  * @param string  HTTP header name, like 'Location'
  * @param string  HTTP header value, like 'http://www.example.com/'
+ * @param string $name
+ * @param string $value
  *
  */
 function xhprof_http_header($name, $value) {
@@ -58,6 +60,7 @@ 
  * Genearte and send MIME header for the output image to client browser.
  *
  * @author cjiang
+ * @param integer $length
  */
 function xhprof_generate_mime_header($type, $length) {
   switch ($type) {
@@ -93,6 +96,7 @@ 
  * @param dot_script, string, the script for DOT to generate the image.
  * @param type, one of the supported image types, see
  * $xhprof_legal_image_types.
+ * @param string $dot_script
  * @returns, binary content of the generated image on success. empty string on
  *           failure.
  *

include/SugarXHprof/xhprof_lib/utils/xhprof_lib.php

Doc Comments +3 added lines

@@ -706,6 +706,7 @@ 
  * Set one key in an array and return the array
  *
  * @author Kannan
+ * @param string $k
  */
 function xhprof_array_set($arr, $k, $v) {
   $arr[$k] = $v;
@@ -716,6 +717,7 @@ 
  * Removes/unsets one key in an array and return the array
  *
  * @author Kannan
+ * @param string $k
  */
 function xhprof_array_unset($arr, $k) {
   unset($arr[$k]);
@@ -739,6 +741,7 @@ 
  * @param string   name of the URL query string param
  *
  * @author Kannan
+ * @return string
  */
 function xhprof_get_param_helper($param) {
   $val = null;

include/SugarXHprof/xhprof_lib/utils/xhprof_runs.php

Doc Comments +6 added lines

@@ -85,6 +85,9 @@ 
     return $file;
   }
 
+  /**
+   * @param string $dir
+   */
   public function __construct($dir = null) {
 
     // if user hasn't passed a directory location,
@@ -123,6 +126,9 @@ 
     return unserialize($contents);
   }
 
+  /**
+   * @param string $type
+   */
   public function save_run($xhprof_data, $type, $run_id = null) {
 
     // Use PHP serialize function to store the XHProf's