adamjakab / SuiteCRM

include/Sugarpdf/FontManager.php

Doc Comments +3 added lines, -3 removed lines

@@ -139,7 +139,7 @@ 
     /**
      * This method calculate the font size of $this->filename in KB
      * .php file + .z file + .ctg.z file
-     * @return Integer font Size in KB
+     * @return double font Size in KB
      */
     private function getFontSize(){
         $fileSize=filesize($this->fontPath.$this->filename);
@@ -326,8 +326,8 @@ 
     }
     /**
      * This method add a font to SugarCRM from a font file and a metric file using MakeFont()
-     * @param $font_file string
-     * @param $metric_file string
+     * @param string $font_file string
+     * @param string $metric_file string
      * @param $embedded boolean
      * @param $encoding_table string
      * @param $patch array

include/Sugarpdf/Sugarpdf.php

Doc Comments +7 added lines, -6 removed lines

@@ -263,7 +263,7 @@ 
     *
     * @param string $family Family font. It can be either a name defined by AddFont() or one of the standard Type1 families (case insensitive):<ul><li>times (Times-Roman)</li><li>timesb (Times-Bold)</li><li>timesi (Times-Italic)</li><li>timesbi (Times-BoldItalic)</li><li>helvetica (Helvetica)</li><li>helveticab (Helvetica-Bold)</li><li>helveticai (Helvetica-Oblique)</li><li>helveticabi (Helvetica-BoldOblique)</li><li>courier (Courier)</li><li>courierb (Courier-Bold)</li><li>courieri (Courier-Oblique)</li><li>courierbi (Courier-BoldOblique)</li><li>symbol (Symbol)</li><li>zapfdingbats (ZapfDingbats)</li></ul> It is also possible to pass an empty string. In that case, the current family is retained.
     * @param string $style Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line trough</li></ul> or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats basic fonts or other fonts when not defined.
-    * @param float $size Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12
+    * @param integer $size Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12
     * @param string $fontfile The font definition file. By default, the name is built from the family and style, in lower case with no spaces.
     * @access public
     * @see include/tcpdf/TCPDF#SetFont()
@@ -299,6 +299,7 @@ 
      * the string to print in the PDF.
      * The cell method is used by all the methods which print text (Write, MultiCell).
      * @see include/tcpdf/TCPDF#Cell()
+     * @param integer $w
      */
     public function Cell($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=0, $link='', $stretch=0) {
         parent::Cell($w, $h, prepare_string($txt), $border, $ln, $align, $fill, $link, $stretch);
@@ -425,7 +426,7 @@ 
      *              Array[line number (0 to x)][cell header]['options'] = Array[cell properties] = values
      * @param $returnHtml (bool) Return the table as HTML code instead of printing the HTML table
      * @param $options Array which can contain : table (array of "HTML proprty"=>"value"),td (array of "HTML proprty"=>"value"), tr (array of "HTML proprty"=>"value"), isheader(bool), header (array of "HTML proprty"=>"value"), width (array 'column name'=>'width value + unit OR nothing')
-     * @return the HTML code if $returnHtml set to true
+     * @return string|null HTML code if $returnHtml set to true
      */
     public function writeHTMLTable($item, $returnHtml=false, $options=NULL){
         //TODO ISSUE - width in % for the td have to be multiply by the number of column.
@@ -488,10 +489,10 @@ 
 
     /**
      * return the HTML code of the value wrap with the tag $tag. This method handle options (general and specific)
-     * @param $tag
+     * @param string $tag
      * @param $value
      * @param $options
-     * @return the HTML wrapped code
+     * @return string HTML wrapped code
      */
     private function wrap($tag, $value, $options){
         if(empty($options[$tag])){
@@ -515,7 +516,7 @@ 
      * Return the heigth of a line depending of the width, the font and the content
      * @param $line Array containing the data of all the cells of the line
      * @param $width Array containing the width of all the cells of the line
-     * @return The heigth of the line
+     * @return double heigth of the line
      */
     private function getLineHeightFromArray($line, $width){
         $h=0;
@@ -618,7 +619,7 @@ 
     * between words.
     * This method returns the estimated number of lines required to print the text.
     * @param string $txt text to print
-    * @param float $w width of cell. If 0, they extend up to the right margin of the page.
+    * @param integer $w width of cell. If 0, they extend up to the right margin of the page.
     * @return int Return the estimated number of lines.
     * @access public
     * @since 4.5.011

include/Sugarpdf/SugarpdfFactory.php

Doc Comments +6 added lines, -2 removed lines

@@ -45,7 +45,8 @@ 
     /**
      * load the correct Tcpdf
      * @param string $type Tcpdf Type
-     * @return valid Tcpdf
+     * @param string $module
+     * @return Sugarpdf Tcpdf
      */
     function loadSugarpdf($type = 'default', $module, $bean = null, $sugarpdf_object_map = array()){
         $type = strtolower(basename($type));
@@ -109,7 +110,9 @@ 
      * This is a private function which just helps the getSugarpdf function generate the
      * proper Tcpdf object
      * 
-     * @return a valid Sugarpdf
+     * @param string $file
+     * @param string $type
+     * @return Sugarpdf valid Sugarpdf
      */
     function _buildFromFile($file, &$bean, $sugarpdf_object_map, $type, $module){
         require_once($file);
@@ -132,6 +135,7 @@ 
      * @param object bean = the bean to pass to the Sugarpdf
      * @param array Sugarpdf_object_map - the array which holds obejcts to pass between the
      *                                controller and the tcpdf.
+     * @param string $class
      * 
      * @return Sugarpdf
      */

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,