chamilo / chamilo-lms

main/inc/lib/phpdocx/pdf/include/page_frame_decorator.cls.php

Doc Comments +2 added lines, -2 removed lines

@@ -171,7 +171,7 @@ 
    * @link http://www.w3.org/TR/CSS21/page.html#forced
    *
    * @param Frame $frame the frame to check
-   * @return bool true if a page break occured
+   * @return null|boolean true if a page break occured
    */
   function check_forced_page_break(Frame $frame) {
 
@@ -426,7 +426,7 @@ 
    * correct location.
    *
    * @param Frame $frame the frame to check
-   * @return Frame the frame following the page break
+   * @return boolean the frame following the page break
    */
   function check_page_break(Frame $frame) {
     // Do not split if we have already

main/inc/lib/phpdocx/pdf/include/pdflib_adapter.cls.php

Doc Comments +5 added lines, -2 removed lines

@@ -442,6 +442,9 @@ 
    * @param string corner
    * @param string join
    * @param array dash
+   * @param double $width
+   * @param string $cap
+   * @param string $join
    */
   protected function _set_line_style($width, $cap, $join, $dash) {
 
@@ -795,8 +798,8 @@ 
    * @param string $font the font file to use
    * @param float $size the font size, in points
    * @param array $color
-   * @param float $adjust word spacing adjustment
-   * @param float $angle angle to write the text at, measured CW starting from the x-axis
+   * @param integer $adjust word spacing adjustment
+   * @param integer $angle angle to write the text at, measured CW starting from the x-axis
    */
   function page_text($x, $y, $text, $font, $size, $color = array(0,0,0),
                      $adjust = 0, $angle = 0,  $blend = "Normal", $opacity = 1.0) {

main/inc/lib/phpdocx/pdf/include/style.cls.php

Doc Comments +27 added lines, -2 removed lines

@@ -742,6 +742,10 @@ 
    * Assume that __set will be also called when this is called, so do not check validity again.
    * Only created, if !important exists -> always set true.
    */
+
+  /**
+   * @param string $prop
+   */
   function important_set($prop) {
       $prop = str_replace("-", "_", $prop);
       $this->_important_props[$prop] = true;
@@ -1276,7 +1280,8 @@ 
   /**
    * Return a single border property
    *
-   * @return mixed
+   * @param string $side
+   * @return string
    */
   protected function _get_border($side) {
     $color = $this->__get("border_" . $side . "_color");
@@ -1363,6 +1368,10 @@ 
    * Applicable for background, border, padding, margin, font, list_style
    * Note: $type has a leading underscore (or is empty), the others not.
    */
+
+  /**
+   * @param string $side
+   */
   protected function _set_style_side_type($style,$side,$type,$val,$important) {
     if ( !isset($this->_important_props[$style.'_'.$side.$type]) || $important) {
       //see __set and __get, on all assignments clear cache!
@@ -1381,6 +1390,9 @@ 
       $this->_set_style_side_type($style,'left',$type,$left,$important);
   }
 
+  /**
+   * @param boolean $important
+   */
   protected function _set_style_type($style,$type,$val,$important) {
     $arr = explode(" ", $val);
     switch (count($arr)) {
@@ -1404,6 +1416,10 @@ 
     $this->_props[$style.$type] = $val;
   }
 
+  /**
+   * @param string $style
+   * @param string $type
+   */
   protected function _set_style_type_important($style,$type,$val) {
     $this->_set_style_type($style,$type,$val,isset($this->_important_props[$style.$type]));
   }
@@ -1411,12 +1427,21 @@ 
   /* Anyway only called if _important matches and is assigned
    * E.g. _set_style_side_type($style,$side,'',str_replace("none", "0px", $val),isset($this->_important_props[$style.'_'.$side]));
    */
+
+  /**
+   * @param string $style
+   * @param string $side
+   */
   protected function _set_style_side_width_important($style,$side,$val) {
     //see __set and __get, on all assignments clear cache!
     $this->_prop_cache[$style.'_'.$side] = null;
     $this->_props[$style.'_'.$side] = str_replace("none", "0px", $val);
   }
 
+  /**
+   * @param string $style
+   * @param boolean $important
+   */
   protected function _set_style($style,$val,$important) {
     if ( !isset($this->_important_props[$style]) || $important) {
       if ($important) {
@@ -1505,7 +1530,6 @@ 
    * Set the background image url
    *
    * @link http://www.w3.org/TR/CSS21/colors.html#background-properties
-   * @param string $url
    */
   function set_background_image($val) {
     //see __set and __get, on all assignments clear cache, not needed on direct set through __set
@@ -1769,6 +1793,7 @@ 
    *
    * @param string $side
    * @param string $border_spec  ([width] [style] [color])
+   * @param boolean $important
    */
   protected function _set_border($side, $border_spec, $important) {
     $border_spec = str_replace(",", " ", $border_spec);

main/inc/lib/phpdocx/pdf/include/table_frame_decorator.cls.php

Doc Comments -1 removed lines

@@ -129,7 +129,6 @@
    * added to the clone.  This method is overidden in order to remove
    * frames from the cellmap properly.
    *
-   * @param Frame $row
    */
   function split($child = null) {
 

main/inc/lib/phpdocx/pdf/include/tcpdf_adapter.cls.php

Doc Comments +4 added lines, -4 removed lines

@@ -179,7 +179,7 @@ 
   /**
    * Sets the stroke colour
    *
-   * @param array $color
+   * @param array $colour
    */
   protected function _set_stroke_colour($colour) {
     $colour[0] = round(255 * $colour[0]);
@@ -196,7 +196,7 @@ 
   /**
    * Sets the fill colour
    *
-   * @param array $color
+   * @param array $colour
    */
   protected function _set_fill_colour($colour) {
     $colour[0] = round(255 * $colour[0]);
@@ -391,7 +391,7 @@ 
    * @param string $font the font file to use
    * @param float $size the font size, in points
    * @param array $color
-   * @param float $adjust word spacing adjustment
+   * @param integer $adjust word spacing adjustment
    */
   function text($x, $y, $text, $font, $size, $color = array(0,0,0), $adjust = 0){}
 
@@ -421,7 +421,7 @@ 
    * @param string $text the text to be sized
    * @param string $font the desired font
    * @param float  $size the desired font size
-   * @param float  $spacing word spacing, if any
+   * @param integer  $spacing word spacing, if any
    * @return float
    */
   function get_text_width($text, $font, $size, $spacing = 0){}

main/inc/lib/phpdocx/pdf/lib/class.pdf.php

Doc Comments +90 added lines

@@ -347,6 +347,8 @@ 
 
   /**
    *destination object, used to specify the location for the user to jump to, presently on opening
+   * @param integer $id
+   * @param string $action
    */
   protected function  o_destination($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -384,6 +386,7 @@ 
 
   /**
    * set the viewer preferences
+   * @param string $action
    */
   protected function  o_viewerPreferences($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -424,6 +427,7 @@ 
 
   /**
    * define the document catalog, the overall controller for the document
+   * @param string $action
    */
   protected function  o_catalog($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -490,6 +494,8 @@ 
 
   /**
    * object which is a parent to the pages in the document
+   * @param integer $id
+   * @param string $action
    */
   protected function  o_pages($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -623,6 +629,8 @@ 
 
   /**
    * define the outlines in the doc, empty for now
+   * @param integer $id
+   * @param string $action
    */
   protected function  o_outlines($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -658,6 +666,8 @@ 
 
   /**
    * an object to hold the font description
+   * @param integer $id
+   * @param string $action
    */
   protected function  o_font($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -827,6 +837,8 @@ 
 
   /**
    * a font descriptor, needed for including additional fonts
+   * @param integer $id
+   * @param string $action
    */
   protected function  o_fontDescriptor($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -885,6 +897,8 @@ 
 
   /**
    * the font encoding
+   * @param integer $id
+   * @param string $action
    */
   protected function  o_fontEncoding($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -930,6 +944,7 @@ 
 
   /**
    * a descendent cid font,  needed for unicode fonts
+   * @param string $action
    */
   protected function  o_fontDescendentCID($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -1019,6 +1034,7 @@ 
 
   /**
    * a font glyph to character map,  needed for unicode fonts
+   * @param string $action
    */
   protected function  o_fontGIDtoCIDMap($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -1061,6 +1077,7 @@ 
 
   /**
    * the document procset, solves some problems with printing to old PS printers
+   * @param string $action
    */
   protected function  o_procset($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -1099,6 +1116,7 @@ 
 
   /**
    * define the document information
+   * @param integer $id
    */
   protected function  o_info($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -1151,6 +1169,8 @@ 
 
   /**
    * an action object, used to link to URLS initially
+   * @param integer $id
+   * @param string $action
    */
   protected function  o_action($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -1200,6 +1220,8 @@ 
   /**
    * an annotation object, this will add an annotation to the current page.
    * initially will support just link annotations
+   * @param integer $id
+   * @param string $action
    */
   protected function  o_annotation($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -1258,6 +1280,7 @@ 
 
   /**
    * a page object, it also creates a contents object to hold its contents
+   * @param string $action
    */
   protected function  o_page($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -1342,6 +1365,8 @@ 
 
   /**
    * the contents objects hold all of the content which appears on pages
+   * @param integer $id
+   * @param string $action
    */
   protected function  o_contents($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -1397,6 +1422,10 @@ 
     }
   }
 
+  /**
+   * @param integer $id
+   * @param string $action
+   */
   protected function  o_embedjs($id, $action, $code = '') {
     if  ($action !== 'new') {
       $o = & $this->objects[$id];
@@ -1419,6 +1448,10 @@ 
     }
   }
   
+  /**
+   * @param integer $id
+   * @param string $action
+   */
   protected function  o_javascript($id, $action, $code = '') {
     if  ($action !== 'new') {
       $o = & $this->objects[$id];
@@ -1444,6 +1477,8 @@ 
 
   /**
    * an image object, will be an XObject in the document, includes description and data
+   * @param integer $id
+   * @param string $action
    */
   protected function  o_image($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -1561,6 +1596,8 @@ 
 
   /**
    * graphics state object
+   * @param integer $id
+   * @param string $action
    */
   protected function  o_extGState($id,  $action,  $options = "") {
     static  $valid_params =  array("LW",  "LC",  "LC",  "LJ",  "ML",
@@ -1604,6 +1641,8 @@ 
 
   /**
    * encryption object.
+   * @param integer $id
+   * @param string $action
    */
   protected function  o_encryption($id, $action, $options = '') {
     if  ($action !== 'new') {
@@ -1679,6 +1718,7 @@ 
 
   /**
    * calculate the 16 byte version of the 128 bit md5 digest of the string
+   * @param string $string
    */
   function  md5_16($string) {
     $tmp =  md5($string);
@@ -1765,6 +1805,11 @@ 
 
   /**
    * add a link in the document to an external URL
+   * @param string $url
+   * @param double $x0
+   * @param double $y0
+   * @param double $x1
+   * @param double $y1
    */
   function  addLink($url, $x0, $y0, $x1, $y1) {
     $this->numObj++;
@@ -1775,6 +1820,11 @@ 
 
   /**
    * add a link in the document to an internal destination (ie. within the document)
+   * @param string $label
+   * @param double $x0
+   * @param double $y0
+   * @param double $x1
+   * @param double $y1
    */
   function  addInternalLink($label, $x0, $y0, $x1, $y1) {
     $this->numObj++;
@@ -2561,6 +2611,10 @@ 
 
   /**
    * draw a line from one set of coordinates to another
+   * @param double $x1
+   * @param double $y1
+   * @param double $x2
+   * @param double $y2
    */
   function  line($x1, $y1, $x2, $y2) {
     $this->objects[$this->currentContents]['c'] .=
@@ -2735,6 +2789,7 @@ 
 
   /**
    * draw a polygon, the syntax for this is similar to the GD polygon command
+   * @param integer $np
    */
   function  polygon($p, $np, $f =  0) {
     $this->objects[$this->currentContents]['c'].=  "\n";
@@ -2755,6 +2810,10 @@ 
   /**
    * a filled rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not
    * the coordinates of the upper-right corner
+   * @param double $x1
+   * @param double $y1
+   * @param double $width
+   * @param double $height
    */
   function  filledRectangle($x1, $y1, $width, $height) {
     $this->objects[$this->currentContents]['c'].=  "\n".sprintf('%.3F', $x1) .' '.sprintf('%.3F', $y1) .' '.sprintf('%.3F', $width) .' '.sprintf('%.3F', $height) .' re f';
@@ -2764,6 +2823,10 @@ 
   /**
    * draw a rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not
    * the coordinates of the upper-right corner
+   * @param double $x1
+   * @param double $y1
+   * @param double $width
+   * @param double $height
    */
   function  rectangle($x1, $y1, $width, $height) {
     $this->objects[$this->currentContents]['c'].=  "\n".sprintf('%.3F', $x1) .' '.sprintf('%.3F', $y1) .' '.sprintf('%.3F', $width) .' '.sprintf('%.3F', $height) .' re S';
@@ -2875,6 +2938,7 @@ 
 
   /**
    * return the height in units of the current font in the given size
+   * @param double $size
    */
   function  getFontHeight($size) {
     if  (!$this->numFonts) {
@@ -3064,6 +3128,8 @@ 
    * on the page the text will end
    *
    * @access private
+   * @param integer $angle
+   * @param integer $wa
    */
   function  PRVTgetTextPosition($x, $y, $angle, $size, $wa, $text) {
     // given this information return an array containing x and y for the end position as elements 0 and 1
@@ -3468,6 +3534,8 @@ 
    * do a part of the calculation for sorting out the justification of the text
    *
    * @access private
+   * @param integer $adjust
+   * @param string $justification
    */
   function  PRVTadjustWrapText($text, $actual, $width, &$x, &$adjust, $justification) {
     switch  ($justification) {
@@ -3717,6 +3785,7 @@ 
 
   /**
    * open an existing object for editing
+   * @param integer $id
    */
   function  reopenObject($id) {
     $this->nStack++;
@@ -3748,6 +3817,7 @@ 
 
   /**
    * stop an object from appearing on pages from this point on
+   * @param integer $id
    */
   function  stopObject($id) {
     // if an object has been appearing on pages up to now, then stop it, this page will
@@ -3760,6 +3830,7 @@ 
 
   /**
    * after an object has been created, it wil only show if it has been added, using this function.
+   * @param integer $id
    */
   function  addObject($id, $options =  'add') {
     // add the specified object to the page
@@ -3835,6 +3906,7 @@ 
 
   /**
    * add content to the documents info object
+   * @param string $label
    */
   function  addInfo($label, $value =  0) {
     // this will only work if the label is one of the valid ones.
@@ -3870,6 +3942,8 @@ 
    * extract an integer from a position in a byte stream
    *
    * @access private
+   * @param integer $pos
+   * @param integer $num
    */
   function  PRVT_getBytes(&$data, $pos, $num) {
     // return the integer represented by $num bytes from $pos within $data
@@ -3936,6 +4010,9 @@ 
   /**
    * add a PNG image into the document, from a file
    * this should work with remote files
+   * @param string $file
+   * @param double $x
+   * @param double $y
    */
   function  addPngFromFile($file, $x, $y, $w =  0, $h =  0) {
     //if already cached, need not to read again
@@ -3978,6 +4055,7 @@ 
 
   /**
    * add a PNG image into the document, from a memory buffer of the file
+   * @param null|string $data
    */
   function  addPngFromBuf($file, $x, $y, $w =  0, $h =  0, &$data) {
 	if ( isset($this->imagelist[$file]) ) {
@@ -4231,6 +4309,9 @@ 
 
   /**
    * add a JPEG image into the document, from a file
+   * @param string $img
+   * @param double $x
+   * @param double $y
    */
   function  addJpegFromFile($img, $x, $y, $w =  0, $h =  0) {
     // attempt to add a jpeg image straight from a file, using no GD commands
@@ -4336,6 +4417,10 @@ 
   /* Check if image already added to pdf image directory.
    * If yes, need not to create again (pass empty data)
    */
+
+  /**
+   * @param string $imgname
+   */
   function  image_iscached($imgname) {
     return isset($this->imagelist[$imgname]);
   }
@@ -4345,6 +4430,7 @@ 
    * common code used by the two JPEG adding functions
    *
    * @access private
+   * @param null|string $data
    */
   function  addJpegImage_common(&$data, $x, $y, $w =  0, $h =  0, $imageWidth, $imageHeight, $channels =  3, $imgname) {
     if ( isset($this->imagelist[$imgname]) ) {
@@ -4377,6 +4463,7 @@ 
 
   /**
    * specify where the document should open when it first starts
+   * @param string $style
    */
   function  openHere($style, $a =  0, $b =  0, $c =  0) {
     // this function will open the document at a specified page, in a specified style
@@ -4402,6 +4489,8 @@ 
 
   /**
    * create a labelled destination within the document
+   * @param string $label
+   * @param string $style
    */
   function  addDestination($label, $style, $a =  0, $b =  0, $c =  0) {
     // associates the given label with the destination, it is done this way so that a destination can be specified after
@@ -4420,6 +4509,7 @@ 
    * define font families, this is used to initialize the font families for the default fonts
    * and for the user to add new ones for their fonts. The default bahavious can be overridden should
    * that be desired.
+   * @param string $family
    */
   function  setFontFamily($family, $options =  '') {
     if  (!is_array($options)) {

main/inc/lib/phpmailer/class.phpmailer.php

Doc Comments +15 added lines, -3 removed lines

@@ -891,6 +891,7 @@ 
   /**
    * Creates recipient headers.
    * @access public
+   * @param string $type
    * @return string
    */
   public function AddrAppend($type, $addr) {
@@ -1258,6 +1259,9 @@ 
   /**
    * Returns the start of a message boundary.
    * @access private
+   * @param string $charSet
+   * @param string $contentType
+   * @param string $encoding
    */
   private function GetBoundary($boundary, $charSet, $contentType, $encoding) {
     $result = '';
@@ -1311,6 +1315,7 @@ 
   /**
    *  Returns a formatted header line.
    * @access public
+   * @param string $name
    * @return string
    */
   public function HeaderLine($name, $value) {
@@ -1320,6 +1325,7 @@ 
   /**
    * Returns a formatted mail line.
    * @access public
+   * @param string $value
    * @return string
    */
   public function TextLine($value) {
@@ -1521,6 +1527,7 @@ 
   /**
    * Encode a header string to best (shortest) of Q, B, quoted or none.
    * @access public
+   * @param string $str
    * @return string
    */
   public function EncodeHeader($str, $position = 'text') {
@@ -1647,7 +1654,6 @@ 
   * Encode string to quoted-printable.
   * Only uses standard PHP, slow, but will always work
   * @access public
-  * @param string $string the text to encode
   * @param integer $line_max Number of chars allowed on a line before wrapping
   * @return string
   */
@@ -1917,6 +1923,7 @@ 
   /**
    * Adds the error message to the error container.
    * @access protected
+   * @param string $msg
    * @return void
    */
   protected function SetError($msg) {
@@ -1966,6 +1973,7 @@ 
   /**
    * Returns a message in the appropriate language.
    * @access private
+   * @param string $key
    * @return string
    */
   private function Lang($key) {
@@ -1992,6 +2000,7 @@ 
   /**
    * Changes every end of line from CR or LF to CRLF.
    * @access private
+   * @param string $str
    * @return string
    */
   private function FixEOL($str) {
@@ -2203,8 +2212,6 @@ 
    * Set the private key file and password to sign the message.
    *
    * @access public
-   * @param string $key_filename Parameter File Name
-   * @param string $key_pass Password for private key
    */
   public function DKIM_QP($txt) {
     $tmp="";
@@ -2318,6 +2325,11 @@ 
     return "X-PHPMAILER-DKIM: phpmailer.worxware.com\r\n".$dkimhdrs.$signed."\r\n";
   }
 
+  /**
+   * @param integer $isSent
+   * @param string $subject
+   * @param string $body
+   */
   protected function doCallback($isSent,$to,$cc,$bcc,$subject,$body) {
     if (!empty($this->action_function) && function_exists($this->action_function)) {
       $params = array($isSent,$to,$cc,$bcc,$subject,$body);

main/inc/lib/phpmailer/class.pop3.php

Doc Comments +1 added lines, -1 removed lines

@@ -192,7 +192,7 @@
    * @param string $host
    * @param integer $port
    * @param integer $tval
-   * @return boolean
+   * @return boolean|null
    */
   public function Connect ($host, $port = false, $tval = 30) {
     //  Are we already connected?

main/inc/lib/phpmailer/class.smtp.php

Doc Comments +4 added lines

@@ -321,6 +321,7 @@ 
    * SMTP CODE FAILURE: 451,554

    * SMTP CODE ERROR  : 500,501,503,421

    * @access public

+   * @param string $msg_data
    * @return bool

    */

   public function Data($msg_data) {

@@ -488,6 +489,8 @@ 
   /**

    * Sends a HELO/EHLO command.

    * @access private

+   * @param string $hello
+   * @param string $host
    * @return bool

    */

   private function SendHello($hello, $host) {

@@ -528,6 +531,7 @@ 
    * SMTP CODE SUCCESS: 552,451,452

    * SMTP CODE SUCCESS: 500,501,421

    * @access public

+   * @param string $from
    * @return bool

    */

   public function Mail($from) {