adamjakab / SuiteCRM

include/tcpdf/fonts/utils/makefont.php

Doc Comments +10 added lines

@@ -347,6 +347,8 @@ 
 
 /**
  * Read UFM file
+ * @param string $file
+ * @param string $cidtogidmap
  */
 function ReadUFM($file, &$cidtogidmap) {
 	//Prepare empty CIDToGIDMap
@@ -422,6 +424,7 @@ 
 
 /**
  * Read AFM file
+ * @param string $file
  */
 function ReadAFM($file,&$map) {
 	//Read a font metric file
@@ -639,6 +642,10 @@ 
 	return rtrim($s);
 }
 
+/**
+ * @param string $file
+ * @param string $s
+ */
 function SaveToFile($file, $s, $mode='t') {
 	$f = fopen($file, 'w'.$mode);
 	if(!$f) {
@@ -658,6 +665,9 @@ 
 	return $a['N'];
 }
 
+/**
+ * @param string $file
+ */
 function CheckTTF($file) {
 	//Check if font license allows embedding
 	$f = fopen($file, 'rb');

include/tcpdf/tcpdf.php

Doc Comments +59 added lines, -108 removed lines

@@ -1613,7 +1613,7 @@ 
 		/**
 		* Set page orientation.
 		* @param string $orientation page orientation. Possible values are (case insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul>
-		* @param boolean $autopagebreak Boolean indicating if auto-page-break mode should be on or off.
+		* @param string|boolean $autopagebreak Boolean indicating if auto-page-break mode should be on or off.
 		* @param float $bottommargin bottom margin of the page.
 		* @access public
 		* @since 3.0.015 (2008-06-06)
@@ -1812,7 +1812,7 @@ 
 		* Defines the left, top and right margins. By default, they equal 1 cm. Call this method to change them.
 		* @param float $left Left margin.
 		* @param float $top Top margin.
-		* @param float $right Right margin. Default value is the left one.
+		* @param integer $right Right margin. Default value is the left one.
 		* @access public
 		* @since 1.0
 		* @see SetLeftMargin(), SetTopMargin(), SetRightMargin(), SetAutoPageBreak()
@@ -1885,7 +1885,7 @@ 
 		/**
 		* Enables or disables the automatic page breaking mode. When enabling, the second parameter is the distance from the bottom of the page that defines the triggering limit. By default, the mode is on and the margin is 2 cm.
 		* @param boolean $auto Boolean indicating if mode should be on or off.
-		* @param float $margin Distance from the bottom of the page.
+		* @param integer $margin Distance from the bottom of the page.
 		* @access public
 		* @since 1.0
 		* @see Cell(), MultiCell(), AcceptPageBreak()
@@ -1899,7 +1899,7 @@ 
 
 		/**
 		* Defines the way the document is to be displayed by the viewer.
-		* @param mixed $zoom The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use. <ul><li>fullpage: displays the entire page on screen </li><li>fullwidth: uses maximum width of window</li><li>real: uses real size (equivalent to 100% zoom)</li><li>default: uses viewer default mode</li></ul>
+		* @param string $zoom The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use. <ul><li>fullpage: displays the entire page on screen </li><li>fullwidth: uses maximum width of window</li><li>real: uses real size (equivalent to 100% zoom)</li><li>default: uses viewer default mode</li></ul>
 		* @param string $layout The page layout. Possible values are:<ul><li>SinglePage Display one page at a time</li><li>OneColumn Display the pages in one column</li><li>TwoColumnLeft Display the pages in two columns, with odd-numbered pages on the left</li><li>TwoColumnRight Display the pages in two columns, with odd-numbered pages on the right</li><li>TwoPageLeft (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left</li><li>TwoPageRight (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right</li></ul>
 		* @param string $mode A name object specifying how the document should be displayed when opened:<ul><li>UseNone Neither document outline nor thumbnail images visible</li><li>UseOutlines Document outline visible</li><li>UseThumbs Thumbnail images visible</li><li>FullScreen Full-screen mode, with no menu bar, window controls, or any other window visible</li><li>UseOC (PDF 1.5) Optional content group panel visible</li><li>UseAttachments (PDF 1.6) Attachments panel visible</li></ul>
 		* @access public
@@ -2283,7 +2283,7 @@ 
 		/**
 	 	 * Set header data.
 		 * @param string $ln header image logo
-		 * @param string $lw header image logo width in mm
+		 * @param integer $lw header image logo width in mm
 		 * @param string $ht string to print as title on document header
 		 * @param string $hs string to print on document header
 		 * @access public
@@ -2361,7 +2361,7 @@ 
 
 		/**
 	 	 * Set a flag to print page footer.
-		 * @param boolean $value set to true to print the page footer (default), false otherwise.
+		 * @param boolean $val set to true to print the page footer (default), false otherwise.
 		 * @access public
 		 */
 		public function setPrintFooter($val=true) {
@@ -2841,7 +2841,7 @@ 
 		* @param string $s The string whose length is to be computed
 		* @param string $fontname Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.
 		* @param string $fontstyle 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.
-		* @param float $fontsize Font size in points. The default value is the current size.
+		* @param integer $fontsize Font size in points. The default value is the current size.
 		* @return int string length
 		* @author Nicola Asuni
 		* @access public
@@ -2853,14 +2853,7 @@ 
 
 		/**
 		* Returns the string length of an array of chars in user unit. A font must be selected.<br>
-		* @param string $arr The array of chars whose total length is to be computed
-		* @param string $fontname Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.
-		* @param string $fontstyle 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.
-		* @param float $fontsize Font size in points. The default value is the current size.
-		* @return int string length
-		* @author Nicola Asuni
-		* @access public
-		* @since 2.4.000 (2008-03-06)
+		* @param integer $fontsize
 		*/
 		public function GetArrStringWidth($sa, $fontname='', $fontstyle='', $fontsize=0) {
 			// store current values
@@ -3110,7 +3103,7 @@ 
 		* Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:<ul><li>They are in the current directory (the one where the running script lies)</li><li>They are in one of the directories defined by the include_path parameter</li><li>They are in the directory defined by the K_PATH_FONTS constant</li></ul><br />
 		* @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
 		* @since 1.0
@@ -3182,7 +3175,7 @@ 
 		/**
 		* Defines the page and position a link points to.
 		* @param int $link The link identifier returned by AddLink()
-		* @param float $y Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)
+		* @param integer $y Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)
 		* @param int $page Number of target page; -1 indicates the current page. This is the default value
 		* @access public
 		* @since 1.5
@@ -3358,7 +3351,7 @@ 
 
 		/**
 		* Add page if needed.
-		* @param float $h Cell height. Default value: 0.
+		* @param integer $h Cell height. Default value: 0.
 		* @param mixed $y starting y position, leave empty for current position.
 		* @return boolean true in case of page break, false otherwise.
 		* @since 3.2.000 (2008-07-01)
@@ -3396,9 +3389,9 @@ 
 		* Prints a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.<br />
 		* If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
 		* @param float $w Cell width. If 0, the cell extends up to the right margin.
-		* @param float $h Cell height. Default value: 0.
+		* @param integer $h Cell height. Default value: 0.
 		* @param string $txt String to print. Default value: empty string.
-		* @param mixed $border Indicates if borders must be drawn around the cell. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
+		* @param integer $border Indicates if borders must be drawn around the cell. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
 		* @param int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul>
 		Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
 		* @param string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul>
@@ -3449,9 +3442,9 @@ 
 		* Returns the PDF string code to print a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.<br />
 		* If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
 		* @param float $w Cell width. If 0, the cell extends up to the right margin.
-		* @param float $h Cell height. Default value: 0.
+		* @param integer $h Cell height. Default value: 0.
 		* @param string $txt String to print. Default value: empty string.
-		* @param mixed $border Indicates if borders must be drawn around the cell. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
+		* @param integer $border Indicates if borders must be drawn around the cell. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
 		* @param int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul>Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
 		* @param string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul>
 		* @param int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
@@ -3681,7 +3674,7 @@ 
 		* @param float $w Width of cells. If 0, they extend up to the right margin of the page.
 		* @param float $h Cell minimum height. The cell extends automatically if needed.
 		* @param string $txt String to print
-		* @param mixed $border Indicates if borders must be drawn around the cell block. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
+		* @param integer $border Indicates if borders must be drawn around the cell block. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
 		* @param string $align Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align</li><li>C: center</li><li>R: right align</li><li>J: justification (default value when $ishtml=false)</li></ul>
 		* @param int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
 		* @param int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
@@ -3691,7 +3684,7 @@ 
 		* @param int $stretch stretch carachter mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if necessary</li><li>4 = forced character spacing</li></ul>
 		* @param boolean $ishtml set to true if $txt is HTML content (default = false).
 		* @param boolean $autopadding if true, uses internal padding and automatically adjust it to account for line width.
-		* @param float $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature. This feature works only when $ishtml=false.
+		* @param integer $maxh maximum height. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature. This feature works only when $ishtml=false.
 		* @return int Return the number of cells or 1 for html mode.
 		* @access public
 		* @since 1.3
@@ -3852,7 +3845,7 @@ 
 
 		/**
 		* Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages)
-		* @param mixed $border Indicates if borders must be drawn around the cell block. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
+		* @param integer $border Indicates if borders must be drawn around the cell block. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
 		* @param string multicell position: 'start', 'middle', 'end'
 		* @return border mode
 		* @access protected
@@ -3932,7 +3925,7 @@ 
 		/**
 		* 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
@@ -3975,8 +3968,8 @@ 
 		* @param int $stretch stretch carachter mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if necessary</li><li>2 = forced horizontal scaling</li><li>3 = character spacing only if necessary</li><li>4 = forced character spacing</li></ul>
 		* @param boolean $firstline if true prints only the first line and return the remaining string.
 		* @param boolean $firstblock if true the string is the starting of a line.
-		* @param float $maxh maximum height. The remaining unprinted text will be returned. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature.
-		* @return mixed Return the number of cells or the remaining string if $firstline = true.
+		* @param integer $maxh maximum height. The remaining unprinted text will be returned. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature.
+		* @return string Return the number of cells or the remaining string if $firstline = true.
 		* @access public
 		* @since 1.5
 		*/
@@ -4316,7 +4309,7 @@ 
 		* @param string $strarr The input array of characters.
 		* @param int $start the starting element of $strarr.
 		* @param int $end first element that will not be returned.
-		* @return Return part of a string
+		* @return string part of a string
 		* @access public
 		*/
 		public function UTF8ArrSubString($strarr, $start='', $end='') {
@@ -4338,7 +4331,7 @@ 
 		* @param string $uniarr The input array of characters.
 		* @param int $start the starting element of $strarr.
 		* @param int $end first element that will not be returned.
-		* @return Return part of a string
+		* @return string part of a string
 		* @access public
 		* @since 4.5.037 (2009-04-07)
 		*/
@@ -4370,7 +4363,7 @@ 
 		/**
 		* Returns the unicode caracter specified by UTF-8 code
 		* @param int $c UTF-8 code
-		* @return Returns the specified character.
+		* @return string the specified character.
 		* @author Miguel Perez, Nicola Asuni
 		* @access public
 		* @since 2.3.000 (2008-03-05)
@@ -4409,8 +4402,8 @@ 
 		* @param string $file Name of the file containing the image.
 		* @param float $x Abscissa of the upper-left corner.
 		* @param float $y Ordinate of the upper-left corner.
-		* @param float $w Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
-		* @param float $h Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
+		* @param integer $w Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
+		* @param integer $h Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
 		* @param string $type Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.
 		* @param mixed $link URL or identifier returned by AddLink().
 		* @param string $align Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
@@ -4419,7 +4412,7 @@ 
 		* @param string $palign Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
 		* @param boolean $ismask true if this image is a mask, false otherwise
 		* @param mixed $imgmask image object returned by this function or false
-		* @param mixed $border Indicates if borders must be drawn around the image. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
+		* @param integer $border Indicates if borders must be drawn around the image. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
 		* @param boolean $fitbox If true scale image dimensions proportionally to fit within the ($w, $h) box.
 		* @return image information
 		* @access public
@@ -4667,10 +4660,6 @@ 
 		/**
 		* Convert the loaded php image to a JPEG and then return a structure for the PDF creator.
 		* This function requires GD library and write access to the directory defined on K_PATH_CACHE constant.
-		* @param string $file Image file name.
-		* @param image $image Image object.
-		* return image JPEG image object.
-		* @access protected
 		*/
 		protected function _toJPEG($image) {
 			$tempname = tempnam(K_PATH_CACHE, 'jpg_');
@@ -4814,7 +4803,7 @@ 
 		* Reads up to length  bytes from the file pointer referenced by handle. Reading stops as soon as one of the following conditions is met: length bytes have been read; EOF (end of file) is reached.
 		* @param resource $handle
 		* @param int $length
-		* @return Returns the read string or FALSE in case of error.
+		* @return false|string the read string or FALSE in case of error.
 		* @author Nicola Asuni
 		* @access protected
 		* @since 4.5.027 (2009-03-16)
@@ -4836,8 +4825,8 @@ 
 		* @param string $file Name of the file containing the image.
 		* @param float $x Abscissa of the upper-left corner.
 		* @param float $y Ordinate of the upper-left corner.
-		* @param float $w Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
-		* @param float $h Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
+		* @param integer $w Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
+		* @param integer $h Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
 		* @param string $type Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.
 		* @param mixed $link URL or identifier returned by AddLink().
 		* @param string $align Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
@@ -6994,8 +6983,8 @@ 
 		 * @param int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
 		 * @param boolean $firstline if true prints only the first line and return the remaining string.
 		 * @param array $color array of RGB text color
-		 * @param string $style font style (U, D, B, I)
-		 * @return the number of cells used or the remaining text if $firstline = true;
+		 * @param integer $style font style (U, D, B, I)
+		 * @return string number of cells used or the remaining text if $firstline = true;
 		 * @access public
 		 */
 		public function addHtmlLink($url, $name, $fill=0, $firstline=false, $color='', $style=-1) {
@@ -7408,7 +7397,7 @@ 
 
 		/**
 		* Reflection against a straight line through point (x, y) with the gradient angle (angle).
-		* @param float $angle gradient angle of the straight line. Default is 0 (horizontal line).
+		* @param integer $angle gradient angle of the straight line. Default is 0 (horizontal line).
 		* @param int $x abscissa of the point. Default is current x position
 		* @param int $y ordinate of the point. Default is current y position
 		* @access public
@@ -7600,7 +7589,7 @@ 
 
 		/**
 		* Returns the current the line width.
-		* @return int Line width
+		* @return double Line width
 		* @access public
 		* @since 2.1.000 (2008-01-07)
 		* @see Line(), SetLineWidth()
@@ -7990,7 +7979,7 @@ 
 		* @param float $x0 Abscissa of center point.
 		* @param float $y0 Ordinate of center point.
 		* @param float $rx Horizontal radius.
-		* @param float $ry Vertical radius (if ry = 0 then is a circle, see {@link Circle Circle}). Default value: 0.
+		* @param integer $ry Vertical radius (if ry = 0 then is a circle, see {@link Circle Circle}). Default value: 0.
 		* @param float $angle: Angle oriented (anti-clockwise). Default value: 0.
 		* @param float $astart: Angle start of draw line. Default value: 0.
 		* @param float $afinish: Angle finish of draw line. Default value: 360.
@@ -8205,37 +8194,7 @@ 
 		* Draws a regular polygon.
 		* @param float $x0 Abscissa of center point.
 		* @param float $y0 Ordinate of center point.
-		* @param float $r: Radius of inscribed circle.
-		* @param integer $ns Number of sides.
-		* @param float $angle Angle oriented (anti-clockwise). Default value: 0.
-		* @param boolean $draw_circle Draw inscribed circle or not. Default value: false.
-		* @param string $style Style of rendering. Possible values are:
-		* <ul>
-		*	 <li>D or empty string: Draw (default).</li>
-		*	 <li>F: Fill.</li>
-		*	 <li>DF or FD: Draw and fill.</li>
-		*	 <li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li>
-		*	 <li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li>
-		* </ul>
-		* @param array $line_style Line style of polygon sides. Array with keys among the following:
-		* <ul>
-		*	 <li>all: Line style of all sides. Array like for {@link SetLineStyle SetLineStyle}.</li>
-		*	 <li>0 to ($ns - 1): Line style of each side. Array like for {@link SetLineStyle SetLineStyle}.</li>
-		* </ul>
-		* If a key is not present or is null, not draws the side. Default value is default line style (empty array).
-		* @param array $fill_color Fill color. Format: array(red, green, blue). Default value: default color (empty array).
-		* @param string $circle_style Style of rendering of inscribed circle (if draws). Possible values are:
-		* <ul>
-		*	 <li>D or empty string: Draw (default).</li>
-		*	 <li>F: Fill.</li>
-		*	 <li>DF or FD: Draw and fill.</li>
-		*	 <li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li>
-		*	 <li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li>
-		* </ul>
-		* @param array $circle_outLine_style Line style of inscribed circle (if draws). Array like for {@link SetLineStyle SetLineStyle}. Default value: default line style (empty array).
-		* @param array $circle_fill_color Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).
-		* @access public
-		* @since 2.1.000 (2008-01-08)
+		* @param integer $angle
 		*/
 		public function RegularPolygon($x0, $y0, $r, $ns, $angle=0, $draw_circle=false, $style='', $line_style=array(), $fill_color=array(), $circle_style='', $circle_outLine_style=array(), $circle_fill_color=array()) {
 			if (3 > $ns) {
@@ -9854,8 +9813,8 @@ 
 		* @param array $col3 third color (upper right corner) (RGB components).
 		* @param array $col4 fourth color (upper left corner) (RGB components).
 		* @param array $coords <ul><li>for one patch mesh: array(float x1, float y1, .... float x12, float y12): 12 pairs of coordinates (normally from 0 to 1) which specify the Bezier control points that define the patch. First pair is the lower left edge point, next is its right control point (control point 2). Then the other points are defined in the order: control point 1, edge point, control point 2 going counter-clockwise around the patch. Last (x12, y12) is the first edge point's left control point (control point 1).</li><li>for two or more patch meshes: array[number of patches]: arrays with the following keys for each patch: f: where to put that patch (0 = first patch, 1, 2, 3 = right, top and left of precedent patch - I didn't figure this out completely - just try and error ;-) points: 12 pairs of coordinates of the Bezier control points as above for the first patch, 8 pairs of coordinates for the following patches, ignoring the coordinates already defined by the precedent patch (I also didn't figure out the order of these - also: try and see what's happening) colors: must be 4 colors for the first patch, 2 colors for the following patches</li></ul>
-		* @param array $coords_min minimum value used by the coordinates. If a coordinate's value is smaller than this it will be cut to coords_min. default: 0
-		* @param array $coords_max maximum value used by the coordinates. If a coordinate's value is greater than this it will be cut to coords_max. default: 1
+		* @param integer $coords_min minimum value used by the coordinates. If a coordinate's value is smaller than this it will be cut to coords_min. default: 0
+		* @param integer $coords_max maximum value used by the coordinates. If a coordinate's value is greater than this it will be cut to coords_max. default: 1
 		* @author Andreas W�rmser, Nicola Asuni
 		* @since 3.1.000 (2008-06-09)
 		* @access public
@@ -10036,6 +9995,12 @@ 
 		* @author Maxime Delorme, Nicola Asuni
 		* @since 3.1.000 (2008-06-09)
 		* @access protected
+		* @param double $x1
+		* @param double $y1
+		* @param double $x2
+		* @param double $y2
+		* @param double $x3
+		* @param double $y3
 		*/
 		protected function _outarc($x1, $y1, $x2, $y2, $x3, $y3 ) {
 			$h = $this->h;
@@ -10052,10 +10017,6 @@ 
 		* @param float $b end angle (in degrees).
 		* @param string $style: D, F, FD or DF (draw, fill, fill and draw). Default: FD.
 		* @param float $cw: indicates whether to go clockwise (default: true).
-		* @param float $o: origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock). Default: 90.
-		* @author Maxime Delorme, Nicola Asuni
-		* @since 3.1.000 (2008-06-09)
-		* @access public
 		*/
 		public function PieSector($xc, $yc, $r, $a, $b, $style='FD', $cw=true, $o=90) {
 			if ($this->rtl) {
@@ -10124,13 +10085,13 @@ 
 		* @param string $file Name of the file containing the image.
 		* @param float $x Abscissa of the upper-left corner.
 		* @param float $y Ordinate of the upper-left corner.
-		* @param float $w Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
-		* @param float $h Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
+		* @param integer $w Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
+		* @param integer $h Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
 		* @param mixed $link URL or identifier returned by AddLink().
 		* @param boolean useBoundingBox specifies whether to position the bounding box (true) or the complete canvas (false) at location (x,y). Default value is true.
 		* @param string $align Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
 		* @param string $palign Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
-		* @param mixed $border Indicates if borders must be drawn around the image. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
+		* @param integer $border Indicates if borders must be drawn around the image. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
 		* @author Valentin Schmidt, Nicola Asuni
 		* @since 3.1.000 (2008-06-09)
 		* @access public
@@ -10904,7 +10865,7 @@ 
 		 * @param float $x upper-left corner X coordinate
 		 * @param float $y upper-left corner Y coordinate
 		 * @param string $html html text to print. Default value: empty string.
-		 * @param mixed $border Indicates if borders must be drawn around the cell. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
+		 * @param integer $border Indicates if borders must be drawn around the cell. The value can be either a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul>
 		 * @param int $ln Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL language)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul>
 	Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
 		 * @param int $fill Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
@@ -12861,8 +12822,8 @@ 
 		/**
 		* Set the booklet mode for double-sided pages.
 		* @param boolean $booklet true set the booklet mode on, fals eotherwise.
-		* @param float $inner Inner page margin.
-		* @param float $outer Outer page margin.
+		* @param integer $inner Inner page margin.
+		* @param integer $outer Outer page margin.
 		* @access public
 		* @since 4.2.000 (2008-10-29)
 		*/
@@ -12945,9 +12906,9 @@ 
         /**
 		* convert html string containing value and unit of measure to user's units or points.
 		* @param string $htmlval string containing values and unit
-		* @param string $refsize reference value in points
+		* @param integer $refsize reference value in points
 		* @param string $defaultunit default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt).
-		* @param boolean $point if true returns points, otherwise returns value in user's units
+		* @param boolean $points if true returns points, otherwise returns value in user's units
 		* @return float value in user's unit or point if $points=true
 		* @access public
 		* @since 4.4.004 (2008-12-10)
@@ -13087,7 +13048,7 @@ 
 		* Output an HTML list bullet or ordered item symbol
 		* @param int $listdepth list nesting level
 		* @param string $listtype type of list
-		* @param float $size current font size
+		* @param integer $size current font size
 		* @access protected
 		* @since 4.4.004 (2008-12-10)
 		*/
@@ -13292,10 +13253,7 @@ 
 
 		/**
 		* Returns a temporary filename for caching object on filesystem.
-		* @param string $prefix prefix to add to filename
-		* return string filename.
-		* @access protected
-		* @since 4.5.000 (2008-12-31)
+		* @param string $name
 		*/
 		protected function getObjFilename($name) {
 			return tempnam(K_PATH_CACHE, $name.'_');
@@ -13303,11 +13261,7 @@ 
 
         /**
 		* Writes data to a temporary file on filesystem.
-		* @param string $file file name
-		* @param mixed $data data to write on file
-		* @param boolean $append if true append data, false replace.
-		* @access protected
-		* @since 4.5.000 (2008-12-31)
+		* @param string $data
 		*/
 		protected function writeDiskCache($filename, $data, $append=false) {
 			if ($append) {
@@ -13332,10 +13286,7 @@ 
 
         /**
 		* Read data from a temporary file on filesystem.
-		* @param string $file file name
-		* @return mixed retrieved data
-		* @access protected
-		* @since 4.5.000 (2008-12-31)
+		* @return string
 		*/
 		protected function readDiskCache($filename) {
 			return file_get_contents($filename);
@@ -13538,7 +13489,7 @@ 
 		* Move a page to a previous position.
 		* @param int $frompage number of the source page
 		* @param int $topage number of the destination page (must be less than $frompage)
-		* @return true in case of success, false in case of error.
+		* @return boolean in case of success, false in case of error.
 		* @access public
 		* @since 4.5.000 (2009-01-02)
 		*/
@@ -13675,7 +13626,7 @@ 
         /**
 		* Remove the specified page.
 		* @param int $page page to remove
-		* @return true in case of success, false in case of error.
+		* @return boolean in case of success, false in case of error.
 		* @access public
 		* @since 4.6.004 (2009-04-23)
 		*/
@@ -14007,7 +13958,7 @@ 
 
 		/**
 		* Creates a copy of a class object
-		* @param object $object class object to be cloned
+		* @param TCPDF $object class object to be cloned
 		* @return cloned object
 		* @access public
 		* @since 4.5.029 (2009-03-19)

include/TemplateHandler/TemplateHandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -310,7 +310,7 @@
      * This function creates the $sqs_objects array that will be used by the quicksearch Javascript
      * code.  The $sqs_objects array is wrapped in a $json->encode call.
      *
-     * @param array $def The vardefs.php definitions
+     * @param array $defs The vardefs.php definitions
      * @param array $defs2 The Meta-Data file definitions
      * @param string $view
      * @param strign $module

include/TimeDate.php

Doc Comments +6 added lines, -6 removed lines

@@ -421,7 +421,7 @@ 
     /**
      * Retrieve the cache key used for user date/time formats
      *
-     * @param $user
+     * @param null|User $user
      * @return string
      */
     public function get_date_time_format_cache_key($user)
@@ -478,7 +478,7 @@ 
      * Split datetime string into date & time
      *
      * @param string $datetime
-     * @return array
+     * @return string
      */
     function split_date_time($datetime)
     {
@@ -1117,7 +1117,7 @@ 
      *
      * @param string $date
      * @param string $time
-     * @return array Date & time in DB format
+     * @return string[] Date & time in DB format
      **/
     public function to_db_date_time($date, $time)
     {
@@ -1225,7 +1225,7 @@ 
     /**
      * Find out format's time separator
      * @param string $timeformat Time format
-     * @return stringS
+     * @return string
      */
     public function timeSeparatorFormat($timeformat)
     {
@@ -1310,7 +1310,7 @@ 
     /**
 	 * Get midnight (start of the day) in local time format
 	 *
-	 * @return Time string
+	 * @return string string
 	 */
 	function get_default_midnight()
 	{
@@ -1748,7 +1748,7 @@ 
     /**
      * @deprecated for public use
      * handles offset values for Timezones and DST
-     * @param	$date	     string		date/time formatted in user's selected format
+     * @param	string $date	     string		date/time formatted in user's selected format
      * @param	$format	     string		destination format value as passed to PHP's date() funtion
      * @param	$to		     boolean
      * @param	$user	     object		user object from which Timezone and DST

include/utils/activity_utils.php

Doc Comments +4 added lines

@@ -39,6 +39,10 @@
  ********************************************************************************/
 
 
+/**
+ * @param string $user_id
+ * @param string $where
+ */
 function build_related_list_by_user_id($bean, $user_id,$where) {
     $bean_id_name = strtolower($bean->object_name).'_id';
 

include/utils/array_utils.php

Doc Comments +7 added lines

@@ -85,6 +85,9 @@ 
  * 			 $eval - evals the generated string if true, note that the array name must be in the global space!
  * @return : example - string $array_name['a']['b']['c'][.] = 'hello'
  */
+/**
+ * @param string $array_name
+ */
 function override_value_to_string_recursive($key_names, $array_name, $value, $eval=false){
 	if ($eval) return eval( "\${$array_name}". override_recursive_helper($key_names, $array_name, $value));
 	else return "\${$array_name}". override_recursive_helper($key_names, $array_name, $value);
@@ -150,6 +153,7 @@ 
 	 * @param array $array2, the array which 
 	 * @param array $allowEmpty, will return the value if it is empty in $array1 and not in $array2,
 	 * otherwise empty values in $array1 are ignored.
+	 * @param string $array1
 	 * @return array containing the differences between the two arrays
 	 */
 	function deepArrayDiff($array1, $array2, $allowEmpty = false) {
@@ -270,6 +274,9 @@ 
         return $array->get($needle, $default);
     }
 
+    /**
+     * @param string $key
+     */
     private function _getFromSource($key, $default) {
         if (strpos($key, '.') === false) {
             return isset($this[$key]) ? $this[$key] : $default;

include/utils/encryption_utils.php

Doc Comments +6 added lines

@@ -40,6 +40,10 @@ 
 
 require_once('include/Pear/Crypt_Blowfish/Blowfish.php');
 
+/**
+ * @param string $key
+ * @param string $data
+ */
 function sugarEncode($key, $data){
 	return base64_encode($data);
 }
@@ -84,6 +88,7 @@ 
  * Uses blowfish to encrypt data and base 64 encodes it. It stores the iv as part of the data
  * @param STRING key - key to base encoding off of
  * @param STRING data - string to be encrypted and encoded
+ * @param string $key
  * @return string
  */
 function blowfishEncode($key, $data){
@@ -96,6 +101,7 @@ 
  * Uses blowfish to decode data assumes data has been base64 encoded with the iv stored as part of the data
  * @param STRING key - key to base decoding off of
  * @param STRING encoded base64 encoded blowfish encrypted data
+ * @param string $key
  * @return string
  */
 function blowfishDecode($key, $encoded){

include/utils/file_utils.php

Doc Comments +12 added lines, -3 removed lines

@@ -61,6 +61,9 @@ 
     return( $appendpath.$path );
 }
 
+/**
+ * @param string $file
+ */
 function create_cache_directory($file)
 {
     $paths = explode('/',$file);
@@ -170,6 +173,9 @@ 
     return( $write_to_file );
 }
 
+/**
+ * @param string $file
+ */
 function create_custom_directory($file)
 {
     $paths = explode('/',$file);
@@ -241,8 +247,8 @@ 
 /**
  * Function to compare two directory structures and return the items in path_a that didn't match in path_b
  *
- * @param	$path_a The path of the first root directory to scan - must end with '/'
- * @param	$path_b The path of the second root directory to scan - must end with '/'
+ * @param	string $path_a The path of the first root directory to scan - must end with '/'
+ * @param	string $path_b The path of the second root directory to scan - must end with '/'
  * @param	$ignore_dirs array of filenames/directory names to ignore running md5 on - default 'cache' and 'upload'
  * @result	array containing all the md5s of everything in $path_a that didn't have a match in $path_b
  */
@@ -374,7 +380,7 @@ 
  * extension and returns a best guess mime content type.
  *
  * @param $filename String of filename to return mime content type
- * @return mime content type as String value (defaults to 'application/octet-stream' for filenames with extension, empty otherwise)
+ * @return string content type as String value (defaults to 'application/octet-stream' for filenames with extension, empty otherwise)
  *
  */
 function get_mime_content_type_from_filename($filename)
@@ -467,6 +473,9 @@ 
 
 }
 */
+/**
+ * @param string $name
+ */
 function cleanFileName($name)
 {
     return preg_replace('/[^\w-._]+/i', '', $name);

include/utils/layout_utils.php

Doc Comments +4 added lines, -3 removed lines

@@ -50,7 +50,7 @@ 
  *
  * @param  $form_title string to display as the title in the header
  * @param  $other_text string to next to the title.  Typically used for form buttons.
- * @param  $show_help  boolean which determines if the print and help links are shown.
+ * @param  false|string $show_help  boolean which determines if the print and help links are shown.
  * @return string HTML
  */
 function get_form_header(
@@ -165,9 +165,10 @@ 
  *
  * @deprecated use SugarView::getModuleTitle() for MVC modules, or getClassicModuleTitle() for non-MVC modules
  *
- * @param  $module       string  to next to the title.  Typically used for form buttons.
- * @param  $module_title string  to display as the module title
+ * @param  string $module       string  to next to the title.  Typically used for form buttons.
+ * @param  string $module_title string  to display as the module title
  * @param  $show_help    boolean which determines if the print and help links are shown.
+ * @param boolean $show_create
  * @return string HTML
  */
 function get_module_title(